HonestHook

RankingsSign in

Home · Docs · Schemas · SeriesPoint

SeriesPoint — one hour of one item's history

A single reading in an item's series: where it sat, how many points it had, how many comments. The archive keeps one of these per item per hour and never deletes them.

SeriesPoint has 4 fields: 2 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
windowstringnono
positionintegernono
pointsintegeryesno
commentsintegeryesno

4 rows above, 2 of them with a transcription from the contract and 0 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.

window

From the contract: Rounded to the hour. This is the bucket, not the exact capture time — two runs in the same hour share a window.

position

From the contract: 1 = top of the ranking.

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 · Item · Mover · Author · PostItem · PostsEnvelope · ProfileEnvelope

← All schemas · Recipes · Full docs