---
title: "Changes to ✨ Get KPI data with optional segmentation"
method: GET
path: "/api/analytics/kpis/{kpi_key}"
---

# Changes to ✨ Get KPI data with optional segmentation

`GET /api/analytics/kpis/{kpi_key}`

> Every recorded change to this operation, newest first.
> 142 revisions in range; 1 not diffed.

## Timeline

Changed in 5 of 142 revisions.

- **2026-10-08** `8fa35ea2a63c`: 1 warning, 1 info
- **2026-08-11** `8ab207b03dd5`: 2 info
- **2026-08-03** `c5d26dd00a92`: 1 breaking, 5 info
- **2026-07-13** `00305e8b0360`: 1 breaking
- **2026-07-07** `0edb4e1e9592`: 1 info

## Changes

- **2026-10-08** `8fa35ea2a63c`: 1 warning, 1 info
  - added the new `user_project` enum value to the `segmentation/allOf[#/components/schemas/SegmentationEnum]/` response property for the response status `200`
  - added the optional property `by_user_project` to the response with the `200` status
- **2026-08-11** `8ab207b03dd5`: 2 info
  - added the new optional `query` request parameter `all`
  - added the optional property `by_user/allOf[#/components/schemas/KPIUserSegment]/total` to the response with the `200` status
- **2026-08-03** `c5d26dd00a92`: 1 breaking, 5 info
  - the `query` request parameter `segment_by_time` was restricted to a list of enum values
  - added the new enum value `daily` to the `query` request parameter `segment_by_time`
  - added the new enum value `hourly` to the `query` request parameter `segment_by_time`
  - added the new enum value `monthly` to the `query` request parameter `segment_by_time`
  - added the new enum value `weekly` to the `query` request parameter `segment_by_time`
  - added the new enum value `yearly` to the `query` request parameter `segment_by_time`
- **2026-07-13** `00305e8b0360`: 1 breaking
  - response property `by_project/allOf[#/components/schemas/KPIProjectSegment]/values/items/` list-of-types was widened by adding types `number` to media type `application/json` of response `200`
- **2026-07-07** `0edb4e1e9592`: 1 info
  - api operation id `api_analytics_kpis_retrieve_2` removed and replaced with `api_analytics_kpis_retrieve`

---

[Operation](https://skmtc.dev/humansignal/apis/label-studio-api/docs/api/analytics/kpis/:kpi_key/get.md) - [API](https://skmtc.dev/humansignal/apis/label-studio-api.md) - [Page](https://skmtc.dev/humansignal/apis/label-studio-api/changes/api/analytics/kpis/:kpi_key/get)