Get KPI values

Error

A valid request URL is required to generate request examples

{
  "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": {}
    }
  ]
}

GET

api

kpis

{id}

values

Get KPI values

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

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

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

KPI values found

kpi

object

Show child attributes

kpi.id

integer

required

Example:

1

kpi.name

string

required

Example:

"Production Rate"

kpi.data_type

enum<string>

required

Available options:

number,

currency

Example:

"number"

kpi.frequency

enum<string>

required

Available options:

shiftly,

daily,

weekly,

monthly

Example:

"daily"

kpi.direction

enum<string>

required

Available options:

higher,

lower

Example:

"higher"

kpi.description

string | null

Example:

"Units produced per hour"

kpi.unit

enum<string>

Available options:

units,

hours,

percentage,

count,

kg,

g,

l,

ml,

pcs,

doses

Example:

"units"

kpi.aggregation

enum<string>

Available options:

sum,

average,

min,

max

Example:

"sum"

values

object[]

Show child attributes

values.date

string<date>

Example:

"2024-03-14"

values.actual

number<float> | null

Example:

95.5

values.target

number<float> | null

Example:

100

values.metadata

object

Example:

{}

List KPIs list orgs

⌘I

API Documentation

Endpoint Examples

Authorizations

Path Parameters

Query Parameters

Response