Topics

Gets an object Hierarchy of Topics | Indicators | Sources

<br>Gets a hierarchy of Topics | Indicators | Sources for given 'Topic Ids' or 'Topic Short Names' (i.e: 'FERT;MORT;FP') parameters or Topic Ids: (i.e: '2,5').

get/api/v1/topics/{topicIdsOrShortNames}/indicators

Request

Base URL
https://population.un.org/dataportalapi
Auth
none declared
TypeScript
https://skmtc.dev/united-nations/apis/data-portal-api/docs/api/v1/topics/:topicIdsOrShortNames/indicators/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

topicIdsOrShortNamesstring required

Accepts either single or multiple 'Topic Ids' (i.e. '2,5,6') 'Topic Short Names' (i.e. 'FP;MarStat;FERT;')

Query parameters

formatstring

Defines respose return format. Possible values are 'json' (default), 'xml' and 'csv'

Response

Returns Status 200 OK

topicIdinteger

topicNamestring nullable

topicShortNamestring nullable

indicatorIdinteger

indicatorNamestring nullable

indicatorDisplayNamestring nullable

indicatorShortNamestring nullable

indicatorDescriptionstring nullable

dimAgeboolean

dimSexboolean

dimVariantboolean

dimCategoryboolean

defaultAgeIdinteger

defaultSexIdinteger

defaultVariantIdinteger

defaultCategoryIdinteger

unitScalingnumber double

formatStringstring nullable

unitLongLabelstring nullable

unitShortLabelstring nullable

variableTypestring nullable

sourceIdinteger nullable

sourceNamestring nullable

sourceYearinteger nullable

sourceStartYearinteger nullable

sourceEndYearinteger nullable

sourceCitationstring nullable

sourceUrlstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.