API
Data API

KPI

Methods allow you to get a list of portal KPIs or information on a specific KPI.



Return a list of KPIs.

GET /kpi
GET
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
Integer
The number of results to return per page.
offset
optional
Integer
The initial index from which to return the results.


Response parameters​



count integer

The number of KPIs.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about KPI's.

  • id integer KPI ID.
  • cid string <= 255 characters Nullable KPI ID in the user system.
  • name string [ 1 .. 255 ] characters KPI name.
  • units string <= 255 characters Nullable KPI indicator unit.






Returns information about KPI by ID.

GET /kpi/{id}
GET
Request
Path Params
id
required
String
KPI ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.


Response parameters



id integer

KPI ID.



cid string <= 255 characters Nullable

KPI ID in the user system.



name string [ 1 .. 255 ] characters

KPI name.



units string <= 255 characters Nullable

KPI indicator unit.









Updated 03 Mar 2023
Did this page help you?
PREVIOUS
DQI types
NEXT
Manufacturers
Docs powered by Archbee