KPI Icons

The KPI icons are used for display purposes and to help identify your KPIs. They are linked to a KPI using the image_id.

KPI Icon Object

The object has the following properties:

Name Type Read Only Mandatory Max Len. Notes
id integer yes no   Internal id
name string yes no   The name of the icon

JSON Example

{
 "id": 1,
 "name": "Target"
}

XML Example

<KPIIcon xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models" 
         xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>1</id>
  <name>Target</name>
</KPIIcon>

 

Get all KPI Icons

GET /api/kpiicons

Using curl

curl https://app.waytobi.com/api/kpiicons
  -v -u {token}

Example Response

Status: 200 OK
[
 {
   "id": 1,
   "name": "Target"
 },
 {
  "id": 4,
  "name": "Loupe"
 }
]

 

Get a KPI Icon

GET /api/kpiicons/{id}

Using curl

curl https://app.waytobi.com/api/kpiicons/{id}
  -v -u {token}

Example Response

Status: 200 OK
{
  "id": 1,
  "name": "Target"
}
 

Unable to find an answer?

Looking for anything specific article which resides in general queries? Just browse the various relevant folders and categories and then you will find the desired article.

Contact Us