UK Data AtlasAPI

Explore geography relationships

Use one route to discover conversions from a release, inspect a specific source and target pair, choose a path for an intended operation, or find relationship coverage gaps.

get
/relationships

Good to know

  • Give sourceGeography and sourceRelease to discover available targets; add the target and purpose to inspect one conversion.
  • Add operation to choose a supported path. Use geography and release, without source parameters, to report coverage.

Query parameters

  • fromstringoptional

    The release to discover or convert from, as {geography}/{release}.

  • tostringoptional

    The release to assess a conversion to, as {geography}/{release}.

  • purposestringoptional

    What the conversion is for, as on /translations. Only applies with to.

    One ofidentitymembershipapportion
    Defaultmembership
  • operationstringoptional

    Select the best published path for this intended conversion operation.

    One ofidentity-joincode-translationcontainment-aggregationmembership-joinweighted-allocation
  • measurestringoptional

    Preflight this measure against an exact conversion's relationship purpose.

  • geographystringoptional
  • releasestringoptional
  • relationstringoptional
    One ofwithincontainssuccessorpredecessorsplit-frommerged-fromequivalent-tooverlaps
  • limitinteger 1–100optional
    Default25

Returns

object

Published relationship paths and evidence, a selected conversion plan, or release-level relationship coverage.

When it goes wrong

  • 400A query parameter is malformed or its cursor is not valid for this result set.
  • 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

The front door for relationship evidence in the boundary archive. Supply from={geography}/{release} to discover every published conversion from one exact release. Add to={geography}/{release} to assess the paths for a purpose, their coverage, trust and permitted operations. Add operation to select the best published path for that intended operation, without translating any codes or values.

Alternatively, supply geography and release to report how fully a release is covered by its published relationships. relation limits that report to one relationship kind. These two query shapes are deliberately separate: conversion is directional between exact releases, whereas coverage is an audit of one release's evidence.