List measures
List every measure you can query, with its unit, what it covers and whether it can be added up. A great place to start exploring.
/measuresqstringoptionalWords to search measures by, such as
house prices. Omit to list every measure.
Returns
EnvelopeMeasure definitions, coverage and supported operations.
apiVersionv1requiredatlasReleasestringrequiredThe immutable
/atlas-releasereleaseIdfor the artifacts that produced this response.metaobjectrequiredShowHide1 child field
nextCursorstring | nullrequiredOpaque cursor for the next page, or null at the end.
- 503The referenced build artifact has not been built yet.
Every error has the same shape. See Errors for how to handle them.
Show the precise behaviourHide the precise behaviour
Each measure retains its source-facing unit label and adds an API-owned unitDefinition. unitDefinition.code is the canonical unit, scaleToCanonical multiplies a published numeric value into that unit, and per names an explicit denominator when one is published. For example, £ million is GBP with a scale of 1000000, and percent is proportion with a scale of 0.01. This is descriptive metadata only: observation values and source artifacts are not rewritten. q searches by the words people use: population, house prices, deprivation. Every measure whose id, alias, label or dataset title holds all of the query's words is listed, best first: an exact id or alias, then a match in the label, then in the id, then anywhere. A search never chooses one measure for the caller, and matching nothing is an empty list rather than a refusal. A measure's aliases, where it has any, are other names each naming it alone, accepted wherever its id is.