website logo
⌘K
🚀Welcome to Eyrene
🎉What's New
😎Tutorials
📱Mobile App
💻Web Portal
🔌API
Docs powered by archbee 

KPI

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

GET /kpi

Return a list of KPIs.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|

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.



GET /kpi/{id}

Returns information about KPI by ID.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|

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 14 Apr 2022
Did this page help you?
Yes
No
UP NEXT
Manufacturers
Docs powered by archbee 
Request example
TABLE OF CONTENTS
GET /kpi
GET
Request example
Response parameters​
GET /kpi/{id}
GET
Request example
Response parameters