Preflight an analysis conversion

Check whether one published period can be compared on a named analysis boundary before retrieving data. The response is a plan: it selects no data and never silently chooses between source partitions.

get
/analysis:plan

Good to know

  • Name sourceGeography and sourceBoundaryYear explicitly, even when a measure has only one obvious source today.
  • An available plan gives you the exact conversion request. A not-comparable plan explains why the named period cannot be used on that frame.
  • measurestringrequired
  • periodstringrequired
  • tostringrequired
  • geographystringrequired
  • boundaryYearintegerrequired

An available or not-comparable analysis plan.

  • 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

Returns a plan only: the selected source partition, the published crosswalk and whether the requested period is comparable on the named analysis frame. It also states the measure's aggregation rule, country-by-country coverage and expected output size, and carries the ranked conversion-plan evidence where that catalogue is available. saferAlternatives always includes the source-exact route, so a caller can keep the publisher's partition when conversion is unnecessary. It does not fetch or transform observations.