Sign in
Analytics

get/analytics/events

Request

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

Query parameters

start_datestring required

Start date in format YYYY-MM-DD HH:MM:SS

end_datestring required

End date in format YYYY-MM-DD HH:MM:SS

project_idinteger required

Project ID or slug

limitinteger

Maximum number of results to return

environment_idinteger

Environment ID (optional)

custom_events_onlyboolean

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

breakdownstring

Breakdown by geography: 'country', 'region', or 'city' (optional)

Response

Successfully retrieved event counts

countinteger required
event_namestring required
percentagenumber double required

Changes

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