Events

Get event counts with filtering

get/projects/{project_id}/events

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/events
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Query parameters

start_datestring required

Start date for filtering events

end_datestring required

End date for filtering events

environment_idinteger

Filter by environment ID

limitinteger

Maximum number of events to return (default: 20, max: 100)

custom_events_onlyboolean

Only return custom events, excluding system events like page_view, page_leave, heartbeat (default: true)

aggregation_levelstring

Aggregation level: events, sessions, or visitors (default: events)

Response

Successfully retrieved event counts

countinteger required
event_namestring required
percentagenumber double required

Changes

No recorded changes to this operation across all 53 revisions of this API.