Check relationship health

A release-by-release summary of how well connected the Atlas's geographies are: how many areas in each have published relationships, and how many are still on their own. Filter with geography or country to narrow it.

get
/geography-health

Good to know

  • A good place to start when deciding whether the geography you need is well enough connected for the conversion you have in mind.
  • status and reach answer different questions. A release can have a relationship on every area and still convert onto nothing: if its only paths lead to other vintages of its own geography, reach is vintage-only. Filter with reach=isolated to see the releases nothing reaches at all.
  • geographystringoptional
  • countrystringoptional
  • reachstringoptional

    Show only the releases whose conversion reach is this.

    One ofconnectedvintage-onlyisolated

Returns

object

Release-level relationship coverage, conversion reach and gaps.

  • 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.

Show the precise behaviour

Reports, release by release, how many compiled areas carry a published relationship and how many carry none, and whether anything can actually be converted onto or off the release. It counts what is published and infers no relationship.

status answers the first question and reach the second, and they can disagree: a release whose every area carries a relationship is available, but if its only published paths lead to other vintages of its own geography its reach is vintage-only and no data can be carried onto another geography. isolated means no published path leaves or arrives at all. reaches and reachedFrom name the other geographies involved.

Releases are ordered by the repair worth doing first: those that convert onto nothing, then those reaching only their own vintages, then unbuilt relationship artifacts, releases with no evidence, and the largest partial gaps.