Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Query Parameters

view
enum<string>
default:size

Grouping.

Available options:
size,
volume,
migration
period
enum<string>
default:week

Window.

Available options:
week,
month
start
string

First day of the period, as YYYY-MM-DD in UTC: a Monday for weeks, the 1st for months. Defaults to the latest finalized period.

Response

OK

data
object[]
required

Result rows.

has_more
boolean
required

true when another page follows.

next_cursor
string | null
required

Cursor for the next page, passed as cursor. null on the last page.

meta
object
required

Response metadata. Its keys depend on the endpoint and are described above.