Analytics

✨ List all available KPIs

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Returns metadata for all available KPI (Key Performance Indicator) classes. Each KPI includes its key, label, base class, dependencies, and configuration. This endpoint is useful for discovering available metrics and understanding their relationships and requirements.
get/api/analytics/kpis/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/analytics/kpis/
  • Auth
    API key in header Authorization

Response

List of available KPIs with metadata

aggregation_methodstring nullable

Aggregation method for the KPI: count, sum, avg, max, min, or snapshot. Snapshot KPIs show point-in-time counts rather than event totals.

base_classstring required

Base class name that the KPI inherits from

calculation_formulaobject nullable

Formula for calculated KPIs defining how to derive the value from component KPIs. Structure: {"type": "ratio|sum|difference|product", "numerator": "kpi_key", "denominator": "kpi_key"}

date_columnstring nullable required

Database column used for date filtering and aggregation

depends_on_kpisstring[] required

List of other KPI keys that this KPI depends on

is_calculatedboolean required

Whether this KPI is calculated from other KPIs (has dependencies)

is_label_typeboolean required

Whether this KPI is a label/filter type that does not show a value per se

keystring required

Unique identifier for the KPI

labelstring nullable required

Human-readable label for the KPI

percentageboolean required

Whether the KPI value is a percentage (DEPRECATED: use unit)

unitstring required

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

Changes