Sign in
Indicator

Retrieves metadata for a given indicator in the system

get/indicator/{Provider}/{ProviderId}

Path parameters

Providerstring required
ProviderIdstring required

Response

OK

idstring uuid
namestring nullable
descriptionstring nullable
aggregate0 | 1 | 2 | 3 | 4 | 5 | 6
calculation0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

The transformation applied to the data.

Possible options:

None 1

PeriodOverPeriod 2

YearOverYear 3

ThreePeriodYearOverYear 6

colorstring nullable
countinteger
createdstring date-time
startTimestring date-time nullable
endTimestring date-time nullable
transformedStartTimestring date-time nullable
transformedEndTimestring date-time nullable
frequency0 | 1 | 2 | 4 | 12 | 52 | 365 | 1000

The frequency of the data.

Daily: 365

Weekly: 52

Monthly: 12

Quarterly: 4

SemiAnnual: 2

Annual: 1

deprecatedboolean
deprecationReasonstring nullable
lastModifiedstring date-time
providerIdstring nullable
seasonality0 | 1 | 999
sourcestring nullable
classification0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
tagsstring[] nullable
typestring nullable
unitsstring nullable
accessibility0 | 1 | 2
periodAlignment0 | 1 | 2
pathstring nullable
notesstring nullable
citationstring nullable
hasZeroVarianceboolean nullable
intervalstring nullable
countryCodestring nullable

Changes

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