API ReferenceAnalyticsKpis

✨ List all available KPIs

<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.

Authentication

AuthorizationToken
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Response

List of available KPIs with metadata
base_classstring
Base class name that the KPI inherits from
date_columnstring or null
Database column used for date filtering and aggregation
depends_on_kpislist of strings
List of other KPI keys that this KPI depends on
is_calculatedboolean

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

is_label_typeboolean

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

keystring
Unique identifier for the KPI
labelstring or null

Human-readable label for the KPI

percentageboolean

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

unitstring

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

aggregation_methodstring or nullOptional

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

calculation_formulamap from strings to any or nullOptional

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”}