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:

JSON Example

{ 
    "id": 5,
    "name": "Calculator"
}

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>
</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"
    },
    {
        "id": 6,
        "name": "Card"
    }
]

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"
}