Events

Get property timeline by grouping events by a column over time

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

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/timeline
  • 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

bucket_sizestring

Time bucket: hour, day, week, month (default: auto-detect)

include_crawlersboolean

Include crawler/bot traffic (default: false)

Response

Successfully retrieved property timeline

bucket_sizestring required
propertystring required

Changes

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