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.
Request example
GET /kpi
GET
https://instance_name/api/data/v1.0/kpi/
curl –i –X GET
https://test.eyrene.com/api/data/v1.1/kpi/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’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.
Request example
GET /kpi/{id}
GET
https://instance_name/api/data/v1.0/kpi/{id}
curl –i –X GET
https://test.eyrene.com/api/data/v1.1/kpi/11/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’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.