GET /v1/reports/events
Retrieve event counts grouped over a time range. Use this endpoint to build trend charts or track the frequency of specific actions.string
required
The event name to query, for example
"Order Completed".string
required
ISO 8601 start date for the report range.
string
required
ISO 8601 end date for the report range.
string
default:"day"
How to group the results. Accepted values:
hour, day, week, month.string
A property filter to narrow results, for example
plan=pro.GET /v1/reports/users
Retrieve active user counts over a time range. Use themetric parameter to switch between daily, weekly, and monthly active user calculations.
string
required
ISO 8601 start date for the report range.
string
required
ISO 8601 end date for the report range.
string
default:"day"
How to group the results. Accepted values:
hour, day, week, month.string
default:"dau"
The active user metric to compute. Accepted values:
dau (daily), wau (weekly), mau (monthly).GET /v1/reports/funnel
Calculate conversion rates across an ordered sequence of events. Use this endpoint to measure how users progress through onboarding flows, checkout steps, or any multi-step process.string[]
required
An ordered array of event names that form the funnel. Users must complete each step in sequence to be counted at the next step.
string
required
ISO 8601 start date for the report range.
string
required
ISO 8601 end date for the report range.