Event timeseries

GET

/api/sites/{id}/events/timeseries

• Local Development

Returns bucketed event counts over time for a given event name. Bucket granularity is hour (<48 h), day (default), or month (≥180 d). Optionally filter to a specific property value to compare property segments over time. Also supports filtering by audience dimension (page, referrer, device, or country) via dimension_key/dimension_value.

Authorizations

• cookieAuth
• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

from

string format: date-time

to

string format: date-time

event_name

required

string

The event name to aggregate counts for.

property_key

string

Optional property key. When combined with property_value, only events matching that property are counted.

property_value

string

Optional property value filter. Requires property_key.

dimension_key

string

Allowed values: path referrer device country

Optional audience dimension to filter by. When combined with dimension_value, restricts counts to sessions where the hit dimension matches.

dimension_value

string

Optional audience dimension value filter. Requires dimension_key.

Responses

200

Event timeseries data

Array<object>

object

time

string format: date-time

count

Number of events in this time bucket.

integer