Skip to main content
POST
Preview Chart

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

period
string | null

Period override: 7d, 30d, or custom:YYYY-MM-DD:YYYY-MM-DD

Body

application/json

For preview — same as ChartConfig but standalone.

queries
QueryDef · object[]
required
Required array length: 1 - 5 elements
compare_previous_period
boolean
default:false
date_range
default:30d
Available options:
1h,
24h,
7d,
30d,
90d,
12m,
all
granularity
enum<string> | null
default:day
Available options:
hour,
day,
week,
month
group_by
string | null
limit
integer
default:50
Required range: 1 <= x <= 500
sort
SortConfig · object | null

Response

Successful Response