HonestHook

RankingsSign in

Home · Docs · Schemas · Item

Item — one thing that was in a ranking, with its whole series

What `archive/trends` returns: an item, when it entered the ranking, when it left, its best position, and the full series of hourly readings behind it.

Item has 9 fields: 1 nullable, 0 guaranteed by the contract's required list. Every number on this page is counted from the field map at render time — none of them is written down.

Fields

FieldTypeNullableRequired
external_idstringnono
titlestringnono
urlstringnono
platformstringnono
entered_atstringnono
left_atstringyesno
best_positionintegernono
movementintegernono
seriesarraynono

9 rows above, 2 of them with a transcription from the contract and 1 with a note of ours.

What the fields mean

Only the fields with something measured or decided about them appear here. A field whose name and type say everything gets no paragraph, rather than a generic one.

left_at

From the contract: null while the item is still in the ranking.

Our note: Null while the item is still in the ranking. It is not a missing value; it is the item not having left yet.

movement

From the contract: Oldest position minus newest. Positive means it climbed. Read this together with `points` in the series: a change of position with no change in points is a tie reshuffle, not a trend.

How this page stays true

The field list, the two flags and the closed value sets are generated from the contract this API serves, and a test compares them against the live /openapi.json in both directions: a field in the contract with no documentation fails, a documented field the contract does not have fails, and a wrong nullable or required fails. The prose marked our note is not covered by that test — it is authored, and labelled so you can tell.

The machine-readable source is at /openapi.json. If you are generating a client, use that rather than this page.

The other 7 schemas

ApiError · SeriesPoint · Mover · Author · PostItem · PostsEnvelope · ProfileEnvelope

← All schemas · Recipes · Full docs