-
Notifications
You must be signed in to change notification settings - Fork 2
Requesting metadata
Parent endpoint: /api/v1/metadata
Note: Child endpoints marked ✅ should work in the prototype. Some params might not be available.
This endpoint returns metadata for topics and indicators. (Note that structural metadata in CSVW and JSON-Stat formats can also be requested from the data endpoint)
/api/v1/metadata/indicators?{parameters} ✅
Returns an array of indicators with their full metadata. The following parameters are available:
| Parameter | Description |
|---|---|
| topic | Specify a topic or sub-topic to filter the list (default "all") |
| hasGeo | Specify a geography group/level (eg. "cauth") or GSS code (eg. "E08000038") to filter the list (default "all") |
| hasYear | Specify a year of interest in the format YYYY to filter the list (default "all") |
| excludeMultivariate | Exclude multi-variate datasets from response (default "false") |
| fullDims | Include all available values for all dimensions of each indicator (default "false") |
| asLookup | Returns a lookup keyed by indicator slug instead of an array/list (default "false") |
/api/v1/metadata/indicators/{indicator}?{parameters} ✅
Returns metadata for an individual indicator. As above, the parameter fullDims=true can be used to include dimensions and their possible values.
/api/v1/metadata/indicators/{indicator}/{dimension} ✅
Returns all possible values for a specific dimension (eg. "areacd" or "period") of a specific indicator.
/api/v1/metadata/taxonomy?{parameters} ✅
Returns a list of all indicators by topic and sub-topic.
By default, the list is nested by topic. Adding a flat=true parameter returns a flattened list of all indicators. topic and subTopic are added as parameters on each indicator.
This endpoint also accepts the topic, hasGeo, hasYear and excludeMultivariate parameters, as described for the indicators endpoint.