UK Data AtlasAPI

Get a time series

Get every value for one area, oldest first. Usually these are published source-exact values; a reviewed analysis geography can instead return values explicitly regrouped onto one named boundary frame.

get
/data/{measure-id}/series

Good to know

  • If a measure has more than one source for that geography, add datasetId to choose between them.
  • Add analysisGeography=geography/release only after checking reviewed conversions. Derived entries name their source and conversion; an unsupported frame returns not-comparable rather than a guessed substitute.

Path parameters

  • measure-idstringrequired

    A measure id from GET /v1/measures, such as population, or one of its aliases, such as house-prices. An alias is read as the id it names, and the response's Content-Location header gives the request it was read as. Case, spaces and punctuation are set aside, so House Prices is house-prices.

Query parameters

  • placestringoptional

    The area, as its name, its code in the source partition, such as E08000035, or a place reference from /places, such as localAuthority/E08000035, which also names its geography. A name is read among the areas the measure is published for; one that means several is a 409 listing each. A postcode, or a larger place the measure is summed over, is answered by /data/{measure-id}/value.

  • geographystringoptional

    The geography the publisher observed the values on. With boundaryYear it selects one source partition of the measure; it never converts values onto another geography. It may be left out when place is a reference such as localAuthority/E08000035, which names it.

    One ofwardlocalAuthorityconstituencylsoamsoadataZonesuperOutputArea
  • boundaryYearintegeroptional

    The year of the boundaries the values are published on. Left out, the geography's newest partition is used and returned in defaults, unless two datasets share it, when datasetId must choose.

  • tostringoptional

    One geography/release pair for a reviewed analysis frame. The source geography and boundary year select a particular partition; omit them to use the current one for place.

  • datasetIdstringoptional

    Narrows the partition to one dataset where a measure has several on the same geography and vintage.

Returns

Envelope

Source-exact or reviewed derived observations in ascending source period order.

  • apiVersionv1required
  • atlasReleasestringrequired

    The immutable /atlas-release releaseId for the artifacts that produced this response.

  • metaobjectrequired
    Show1 child field
    • nextCursorstring | nullrequired

      Opaque cursor for the next page, or null at the end.

When it goes wrong

  • 400A query parameter is malformed or its cursor is not valid for this result set.
  • 404No resource matches that identity.
  • 409An area name means more than one area the measure is published for. choices lists each, with ask, the same request with that area's code and geography in place of the name.
  • 422The requested conversion, aggregation or geometry release is not supported.
  • 503The referenced build artifact has not been built yet.

Every error has the same shape. See Errors for how to handle them.

Technical notes

Show the precise behaviour

Returns all published observations for one area code within one source geography and code vintage. place accepts an area name, code or reference. With no source partition, the current published partition for that place is selected and returned as defaults. Without to, the result is source-exact: it does not select a boundary release, convert values or aggregate them. With to, the result is available only where the exact source partition has a reviewed conversion; every returned value is then labelled derived on that named frame. Supply datasetId when a measure has more than one source for the requested geography and boundary year.