Skip to main content
POST
Query analytics events

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose analytics to read.

Body

application/json

Query request for analytics events with filter expression support.

event_name
string
required

Name of the event to query, exactly as the app tracked it.

Example:

"checkout_completed"

q
string | null

Filter expression, as a JSON object serialized to a string. Omit to return every event with this name in the time range.

Example:

"{\"properties.plan\": {\"in\": [\"pro\", \"elite\"]}}"

offset
integer
default:0

Number of events to skip before the page starts. Pass the next_offset from the previous response to get the next page.

Required range: x >= 0
Example:

0

limit
integer
default:100

Maximum number of events to return, between 1 and 1000.

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

100

Response

The matching events.

total
integer
required

Number of events matching the query, across all pages.

Example:

1842

events
AnalyticsEvent · object[]
required

The requested page of events, newest first.

Example:
has_more
boolean
required

Whether more events match beyond this page.

Example:

true

next_offset
integer | null

Offset to pass as offset to get the next page, or null when has_more is false.

Example:

100