Endpoint
Query parameters
Number of indicators to skip. Minimum: 0.
Maximum number of indicators to return. Minimum: 1. Maximum: 50.
Field to sort results by. Accepted values: name, periodicity, favourites. Unknown values fall back to name.
Sort direction. Accepted values: asc, desc.
When provided, filters results to indicators where governance matches the given value. Omit to return all indicators regardless of governance status.
Response
Returns an array of SimpleIndicator objects. The domain field contains the domain ObjectId string, not a populated domain object.
Show SimpleIndicator properties
ObjectId string uniquely identifying the indicator.
Display name of the indicator.
How frequently the indicator is measured (e.g., "annual", "monthly").
Number of times the indicator has been marked as a favourite.
Whether the indicator is classified as a governance indicator.
Optional longer description of the indicator. null if not set.
Optional data source or font attribution. null if not set.
Optional measurement scale description. null if not set.
Optional unit of measurement (e.g., "tonnes", "%"). null if not set.
Optional carrying capacity value or description. null if not set.
ObjectId string of the domain this indicator belongs to.
Name of the subdomain within the domain.
Array of resource ID strings associated with this indicator.
Examples
curl --request GET \
--url 'http://localhost:8080/indicators/?skip=0&limit=10&sort_by=name&sort_order=asc'
Filtering by governance and sorting by favourites descending:
curl --request GET \
--url 'http://localhost:8080/indicators/?governance_filter=true&sort_by=favourites&sort_order=desc&limit=20'
Sample response
[
{
"id" : "64a1f2b3c4d5e6f7a8b9c0d1" ,
"name" : "Annual tourist arrivals" ,
"periodicity" : "annual" ,
"favourites" : 42 ,
"governance" : false ,
"description" : "Total number of tourist arrivals recorded each year." ,
"font" : "National Tourism Board" ,
"scale" : "national" ,
"unit" : "persons" ,
"carrying_capacity" : null ,
"domain" : "64a1f2b3c4d5e6f7a8b9c0a1" ,
"subdomain" : "Visitor volume" ,
"resources" : [
"64a1f2b3c4d5e6f7a8b9c0b2"
]
},
{
"id" : "64a1f2b3c4d5e6f7a8b9c0d2" ,
"name" : "Carbon emissions per visitor" ,
"periodicity" : "annual" ,
"favourites" : 17 ,
"governance" : true ,
"description" : null ,
"font" : null ,
"scale" : null ,
"unit" : "kg CO2" ,
"carrying_capacity" : "5000 kg CO2 per year" ,
"domain" : "64a1f2b3c4d5e6f7a8b9c0a2" ,
"subdomain" : "Environmental impact" ,
"resources" : []
}
]