Sign in
Dashboard

Analytics for current + previous period

Combined KPI summary and time-series for two ranges (current + previous for deltas). All ranges are computed in the user's timezone (query tz or UTC fallback). Resolution order: query > user settings > default.

get/api/v1/dashboard/analytics

Query parameters

trackerstring[]
team_idstring[] nullable

Narrow analytics to trackers owned by the given teams. Filtered against the caller's permitted set; invalid ids are dropped silently.

Narrow analytics to trackers owned by the given teams. Filtered against the caller's permitted set; invalid ids are dropped silently.

company_user_idstring[] nullable

Narrow analytics to trackers owned by the given company members. Filtered against the caller's permitted set; invalid ids are dropped silently.

Narrow analytics to trackers owned by the given company members. Filtered against the caller's permitted set; invalid ids are dropped silently.

period'today' | 'last_24h' | 'last_7d' | 'this_week' | 'last_30d' | 'this_month' | 'last_90d' | 'this_year' | 'custom' nullable

Period preset id. Required unless the user has a stored defaultPeriod.

Period preset id. Required unless the user has a stored defaultPeriod.

fromstring date-time nullable

Required when period=custom (ISO 8601).

Required when period=custom (ISO 8601).

tostring date-time nullable

Required when period=custom (ISO 8601).

Required when period=custom (ISO 8601).

tzstring nullable

IANA timezone (e.g. Europe/Berlin). UTC fallback.

IANA timezone (e.g. Europe/Berlin). UTC fallback.

chartMetricsstring[] nullable

Subset of fields to include in dataPoints.

Subset of fields to include in dataPoints.

summaryMetricsstring[] nullable

Opt-in summary keys. Currently only uniqueUsers (COUNT DISTINCT) actually changes execution; other keys are always populated.

Opt-in summary keys. Currently only uniqueUsers (COUNT DISTINCT) actually changes execution; other keys are always populated.

Response

Successful Response

period'today' | 'last_24h' | 'last_7d' | 'this_week' | 'last_30d' | 'this_month' | 'last_90d' | 'this_year' | 'custom' required
interval'hour' | 'day' | 'week' required

Changes

No recorded changes to this endpoint across all 1 revision of this API.