Sign in
Events

Get property breakdown by grouping events by a column

get/projects/{project_id}/events/properties/breakdown

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/properties/breakdown
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Query parameters

start_datestring required

Start date in '%Y-%m-%d %H:%M:%S' format

end_datestring required

End date in '%Y-%m-%d %H:%M:%S' format

group_bystring required

Column to group by (channel, device_type, browser, etc.)

environment_idinteger

Filter by environment ID

deployment_idinteger

Filter by deployment ID

event_namestring

Filter by event name

aggregation_levelstring

Aggregation level: events, sessions, or visitors - default: events

limitinteger

Maximum number of results (default: 20, max: 100)

include_crawlersboolean

Include crawler/bot traffic (default: false)

filter_countrystring

Filter by country (for region/city drill-downs)

filter_regionstring

Filter by region (for city drill-downs)

filter_browserstring

Filter by browser name (for version drill-downs)

filter_osstring

Filter by OS name (for version drill-downs)

filter_channelstring

Filter by channel name (for channel drill-downs)

filter_referrerstring

Filter by referrer hostname (for referrer drill-downs)

Response

Successfully retrieved property breakdown

propertystring required
totalinteger required

Changes

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