List KPIs

GET /api/v1/kpis

List KPIs

cURL

curl --request GET \
  --url {protocol}://{host}/api/v1/kpis \
  --header 'Authorization: Bearer <token>'

200

{
  "kpis": [
    {
      "id": 1,
      "name": "Production Rate",
      "data_type": "number",
      "frequency": "daily",
      "direction": "higher",
      "description": "Units produced per hour",
      "unit": "units",
      "aggregation": "sum"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Response

200

application/json

KPIs found

kpis · object[]

Show child attributes