Get a summary of metric events over time
Get a summary of metric events over time for a user.
Authorizations
Headers
The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.
Query Parameters
The time period over which to aggregate the event data.
daily, weekly, monthly The start date for the data range in YYYY-MM-DD format. The startDate must be before the endDate, and the date range must not exceed 400 days.
The end date for the data range in YYYY-MM-DD format. The endDate must be after the startDate, and the date range must not exceed 400 days.
Response
Successful operation
The date of the data point. For weekly or monthly aggregations, this is the first date of the period.
"2024-01-01"
The user's total for this metric at the end of this date.
100
The change in the user's total for this metric during this period.
50