Sources

Gets a list of all Indicators for Sources

<br>Gets a collection of all Indicator Sources if no 'indicators' parameter (either IndicatorIds or IndicatorShortNames) is supplied. <br>Otherwise, it gets only specific Indicator Sources based on {indicators} parameter (either IndicatorIds or IndicatorShortNames). <br>Multiple 'indicators' parameters can be passed in, separated by semi-column (i.e. 'IMR;U5MR' or '1;2;3').

get/api/v1/sources/{sourceIds}/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/sources/:sourceIds/indicators/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sourceIdsstring required

It accepts multiple 'Source Ids' (i.e. '1;2;3')

Query parameters

sortstring

Accepts field name to Sort by. For DESC Sort use hyphen ('-') prefix (i.e. '-id'). If not passed parameter defaults to ASC sort by 'id' field.

formatstring

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

Response

Returns Status 200 OK

idinteger

namestring nullable

shortNamestring nullable

descriptionstring nullable

displayNamestring nullable

dimAgeboolean

dimSexboolean

dimVariantboolean

dimCategoryboolean

defaultAgeIdinteger

defaultSexIdinteger

defaultVariantIdinteger

defaultCategoryIdinteger

variableTypestring nullable

valueTypestring nullable

unitScalingnumber double

precisioninteger

isThousandSeparatorSpaceboolean

formatStringstring nullable

unitShortLabelstring nullable

unitLongLabelstring nullable

nClassesDefaultinteger

downloadFileNamestring nullable

sourceIdinteger

sourceNamestring nullable

sourceYearinteger nullable

sourceStartYearinteger nullable

sourceEndYearinteger nullable

sourceCitationstring nullable

sourceUrlstring nullable

topicIdinteger

topicNamestring nullable

topicShortNamestring nullable

Changes

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