Developer API

KPI Icons

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

KPI Icon Object

The object has the following properties:

NameTypeRead OnlyMandatoryMax Len.Notes
id integer yes no   Internal id
name string yes no   The name of the icon
large_pos string yes no   The background position of the large icon of the icon sprite (http://{subdomain}.simplekpi.com/Content/Images/icon-sprite.png)
small_pos string yes no   The background position of the small icon of the icon sprite (http://{subdomain}.simplekpi.com/Content/Images/icon-sprite.png)

JSON Example

{
 "id": 5,
 "name": "Calculator",
 "large_pos": "0px -232px",
 "small_pos": "-106px -242px"
}

XML Example

<KPIIcon xmlns="http://schemas.datacontract.org/2004/07/SimpleKPI.Application.Areas.Api.Models" 
         xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>5</id>
  <name>Calculator</name>
  <large_pos>0px -232px</large_pos>
  <small_pos>-106px -242px</small_pos>
</KPIIcon>

 

Get all KPI Icons

GET /api/kpiicons

Using curl

curl https://{subdomain}.simplekpi.com/api/kpiicons
  -v -u {email_address}:{token}

Example Response

Status: 200 OK
[
  {
 "id": 5,
 "name": "Calculator",
 "large_pos": "0px -232px",
 "small_pos": "-106px -242px"
 },
{
 "id": 6,
 "name": "Card",
 "large_pos": "0px -116px",
 "small_pos": "-106px -128px"
 }
]

 

Get a KPI Icon

GET /api/kpiicons/{id}

Using curl

curl https://{subdomain}.simplekpi.com/api/kpiicons/{id}
  -v -u {email_address}:{token}

Example Response

Status: 200 OK
{
 "id": 5,
 "name": "Calculator",
 "large_pos": "0px -232px",
 "small_pos": "-106px -242px"
}