Sign in

v76

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-015764591.5 MB
Analytics

Get KPI data with optional segmentation

Retrieve data for a specific KPI with support for filtering and segmentation. Can segment by time (hourly, daily, weekly, monthly, yearly), by user, or both (2D matrix). If no segmentation is specified, returns a single total value. Supports filtering by projects, members, and date range. Date filters are interpreted in the specified timezone (required parameter). Maximum 50 projects allowed per request for performance reasons.

get/api/analytics/kpis/{kpi_key}

Path parameters

kpi_keystring required

KPI identifier (key)

Query parameters

endstring date-time

End date for filtering (ISO format)

membersstring

Comma-separated user IDs. If empty, includes all organization members.

projectsstring

Comma-separated project IDs. If empty, includes all organization projects. Maximum 50 projects allowed per request. Requests exceeding this limit will be rejected with a 400 error.

segment_by_projectboolean

Whether to segment results by project

segment_by_timestring

Time granularity: hourly, daily, weekly, monthly, yearly

segment_by_userboolean

Whether to segment results by user

startstring date-time

Start date for filtering (ISO format)

tzstring required

Timezone for date filtering (IANA timezone name, e.g., "America/New_York", "UTC"). The start and end dates will be interpreted in this timezone.

Response

KPI data with requested segmentation

kpi_keystring required

KPI identifier

kpi_labelstring nullable required

Human-readable KPI label

segmentation'none' | 'time' | 'user' | 'project' | 'matrix' | 'project_matrix' required
  • none - none
  • time - time
  • user - user
  • project - project
  • matrix - matrix
  • project_matrix - project_matrix
unitstring required

Unit of measurement: seconds, minutes, hours, count, or ratio