Skip to main content
GET
Aggregate events

Authorizations

Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Query Parameters

from
string<date-time>
required

Inclusive RFC 3339 start time.

Example:

"2026-04-28T00:00:00.000Z"

to
string<date-time>
required

Exclusive RFC 3339 end time.

Example:

"2026-04-29T00:00:00.000Z"

external_id
string[]

Filter to one or more system-of-record user identifiers.

Maximum array length: 100
Required string length: 1 - 255
Example:
anonymous_id
string[]

Filter to one or more anonymous tracking identifiers.

Maximum array length: 100
Required string length: 1 - 255
Example:
event_name
string[]

Filter to one or more event names.

Maximum array length: 50
Required string length: 1 - 255
Example:
campaign_id
integer[]

Filter to one or more numeric campaign identifiers.

Maximum array length: 25
Example:
group_by
enum<string>[]

Repeat to group by multiple dimensions. Omit to return one total row.

Maximum array length: 4

Dimension used to group event counts.

Available options:
event_name,
campaign,
user,
day
Example:
cursor
string

Opaque cursor returned by a previous page. Omit on the first request.

Maximum string length: 2048
limit
integer
default:50

Maximum groups to return. The maximum page size is 100.

Required range: 1 <= x <= 100
Example:

50

Response

A page of event count groups.

results
object[]
required
nextCursor
string | null
required

Cursor for the next page, or null when there is no next page.

prevCursor
string | null
required

Cursor for the previous page, or null when there is no previous page.

limit
integer
required

Page size used for the response.

Example:

50