Skip to main content
GET
Get Week Timeline

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required

The brand's UUID from listBrands.

Query Parameters

limit
integer
default:20

Maximum rows (100).

Required range: 1 <= x <= 100
cursor
string | null

Prior next_cursor; keep filters and limit.

Maximum string length: 4096
as_of
string<uuid> | null

Completed scan id cutoff.

offset
integer
default:0

Rows to skip; prefer cursor paging.

Required range: x >= 0
week
string<date> | null

Monday starting the week; omit for this week.

day
string<date> | null

UTC day within the selected week; pages rows in lead order.

Response

Successful Response

days
TimelineDay · object[]
required

The week's observed days, newest first.

limit
integer
required

Maximum observations returned.

meta
Meta · object
required

Normalized query and newest included scan.

next_cursor
string | null
required

Pass as cursor with the same query to read the next page; null at the end.

offset
integer
required

Observations skipped.

rows
TimelineItem · object[]
required

A page of observed events, newest first.

total
integer
required

Observations in the selected week.

week
string<date>
required

The Monday starting the week, in UTC.