scoringEligible
The single field to check if you are only going to check one.true only when all of the following hold:
- the source is official or market grade, not news and not an unreviewed feed
- the row is not an annual fallback standing in for a live series
- the reading is not stale against its own expected cadence
- the collection behind it has not been discontinued
- the value is denominated in the unit its factor is defined in
false.
freshnessStatus
Age relative to the series’ own publication cadence, not a fixed window.
A monthly series tolerates far less lag than a quarterly one. This is why a reading
can be the newest one that exists and still be
stale: the publisher is late, and
the API says so rather than presenting the last known value as current.
collectionStatus
ceased when the publisher has permanently retired the collection, null for a
live series.
This is distinct from stale and the distinction matters. A stale series is
expected to resume. A ceased one never will. Treating them the same is a real
modelling error: one is a temporary gap, the other is a permanent end that will
otherwise sit in your model looking like current data forever.
Ceased rows carry two companions:
ceasedFinalPeriod: the last period the collection ever publishedsuccessorIndicatorId: the replacement, where the publisher named one
The successor is a pointer, not a splice. It is usually a different concept.
Australian retail turnover was replaced by household spending, which includes
services. Joining the two into one series would silently change what is being
measured partway through its history, so the API never does that for you. The
decision is yours to make explicitly.
fallbackOnly
true for annual World Bank rows, which exist to give context for countries with no
high frequency source.
They are real data. They are also the wrong thing to score, because they are annual,
frequently revised, and often a year or more behind. They are marked so that a
country with only fallback coverage is visibly different from one with a live
national series.
preferredForFactor
Within a response, the one row to use for a given country, factor and period. The guarantee is exactly one: never two, never zero where an eligible row exists. This exists because ambiguity is worse than absence. If two rows both look authoritative, the choice falls to whatever tie break the consumer happens to apply, and the same query can produce different answers on different runs. A factor score that changes without the world changing is worse than no score. Rows arefalse when superseded by a better one: an annual fallback where an
official series exists, a ceased collection where its successor is present, a
harmonised international copy where the compiling agency’s own print is available.
sourceTier
Provenance ranking, used when several publishers carry the same series.
Where a series has more than one publisher, the API returns one provider per
period rather than both. National sources are preferred over harmonised
international copies. Pass
?sources=all to opt out and receive every provider.