Get KPI values

GET /api/v1/kpis/{id}/values

Error

A valid request URL is required to generate request examples

200

{
  "kpi": {
    "id": 1,
    "name": "Production Rate",
    "data_type": "number",
    "frequency": "daily",
    "direction": "higher",
    "description": "Units produced per hour",
    "unit": "units",
    "aggregation": "sum"
  },
  "values": [
    {
      "date": "2024-03-14",
      "actual": 95.5,
      "target": 100,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · integer · required

Query Parameters

date_from · string<date> · required

Start date for KPI values (YYYY-MM-DD)

date_to · string<date> · required

End date for KPI values (YYYY-MM-DD)

org_id · integer · required

Organization ID to fetch values for

Response

200

application/json

KPI values found

kpi · object

Show child attributes

values · object[]

Show child attributes