Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

hdk_sk_live_v1_… or hdk_sk_test_v1_…

Headers

X-Max-Credits
integer

Refuse (free) if the request could cost more.

X-Credit-Price-Version
integer

Expected price version; 409 price_changed if it differs.

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, YYYY-MM-DD (UTC): a Monday for weeks, the 1st for months. Default: the latest finalized period.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

OK

data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
meta
object
required