List KPIs

List KPIs

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

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

GET

api

kpis

Error

A valid request URL is required to generate request examples

{
  "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

KPIs found

kpis

object[]

Show child attributes

kpis.id

integer

required

Example:

1

kpis.name

string

required

Example:

"Production Rate"

kpis.data_type

enum<string>

required

Available options:

number,

currency

Example:

"number"

kpis.frequency

enum<string>

required

Available options:

shiftly,

daily,

weekly,

monthly

Example:

"daily"

kpis.direction

enum<string>

required

Available options:

higher,

lower

Example:

"higher"

kpis.description

string | null

Example:

"Units produced per hour"

kpis.unit

enum<string>

Available options:

units,

hours,

percentage,

count,

kg,

g,

l,

ml,

pcs,

doses

Example:

"units"

kpis.aggregation

enum<string>

Available options:

sum,

average,

min,

max

Example:

"sum"

Authentication Get KPI values

⌘I

API Documentation

Endpoint Examples

Authorizations

Response