UNunited-nations
Indicators

Returns a list of Indicators filtered by one or more {codes} that can either be Indicator 'id' or 'shortName' separated by semi-column (;) or comma (,)

<br>Filtering options:

<br>* To filter Indicators by Ids: in place of {codes} parameter, pass in comma (,) or semi-column (;) separated list of Indicator Ids (i.e. '1;24;19')
<br>* To filter Indicators by Short Names: in place of {codes} parameter, pass in comma (,) or semi-column (;) separated list of Indicator ShortNames (i.e. 'CPAnyP;U5MR;TFR5')

get/api/v1/Indicators/{codes}

Request

Path parameters

codesstring required

Either multiple 'shortNames' (i.e. 'CPAnyP;U5MR;TFR5') or multiple 'Indicator Ids' (i.e. '1;24;19'). One or the other, mixing is not supported

Query parameters

sortstring

Field name used for record sorting. Must exist on a Model, otherwise error is thrown. Defaults to Ascending sort by 'id' field. Use hypehn (-) in front of the field name to switch sorting direction to Descending

formatstring

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

Response

Returns list of filtered Indicators

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.