Voeg een laag toe
Voeg datasets toe aan een Data Studio-project als lagen, geconfigureerd via de pipeline-inhoud van het project via PUT.
Voeg een laag toe
Een Data Studio-project bevat lagen — de datasets en bronnen die je in de werkruimte brengt om mee te werken. Een laag verwijst naar een of meer datasets en bevat weergave- en filterinstellingen.
Hoe lagen zijn geconfigureerd
Er is geen aparte "laag toevoegen" REST-route — lagen bevinden zich binnen de configuratie van de pipeline van het project, die je instelt door het configuratieobject te verzenden op PUT .../projects/:projectId. Om een laag toe te voegen, haal je het project op, voeg je een vermelding toe aan de lagenlijst en schrijf je het terug.
Een laagvermelding beschrijft uit welke datasets het put, hoe het verschijnt en welke filters zijn toegepast:
| Veld | Type | Beschrijving |
|---|---|---|
id |
string | Stabiele identifier voor de laag binnen het project. |
name |
string | Weergavenaam. |
datasetIds |
string[] | Datasets waaruit de laag put. |
color |
string | Weergavekleur. |
visible |
boolean | Of de laag zichtbaar is. |
filters |
object | Optionele filters (zoekopdrachten, categorieën, steden, landen, postcodes, en meer). |
Voorbeeld
Voeg een enkele laag toe aan een project door de werkruimteconfiguratie te schrijven. Alleen het relevante deel van de body wordt weergegeven:
curl -X PUT \
-H "Authorization: Bearer eyJhbGci..." \
-H "Content-Type: application/json" \
-d '{
"pipeline": {
"version": 1,
"layers": [
{
"id": "layer-hotels",
"name": "Hotels (NL)",
"datasetIds": ["nl-hotels-poi"],
"color": "#2563eb",
"visible": true,
"filters": { "countries": ["nl"] }
}
],
"transformers": [],
"output": { "format": "csv", "includeCoordinates": true, "fields": { "mappings": [] } }
}
}' \
"https://api.topolab.nl/v1/organization/8f0c2e1a-4b6d-4c2a-9e3f-1a2b3c4d5e6f/data-studio/projects/c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f"
De reactie is het bijgewerkte project, inclusief de opgeslagen configuratie. Om meer lagen toe te voegen, stuur je elke keer de volledige lagenlijst — de configuratie wordt vervangen, niet samengevoegd.
Authenticatie
Dezelfde regels als de rest van de API: een Bearer JWT (zie Authenticatie), lidmaatschap van de organisatie, de DATA_STUDIO_CREATE toestemming om een project te wijzigen, en de data-studio add-on.
Volgende
- Voer een pipeline uit — verwerk de lagen die je hebt toegevoegd.
- Maak een project aan — de
PUTbody die lagen bevat. - Wil je Data Studio inschakelen? Neem contact met ons op.