BackAPI reference

KPI Icons

A read-only lookup of the icons a KPI can be given. The ids returned here are what icon_id on a KPI accepts.

Icons are shared across all accounts, so this list is the same for everyone.

Base URL https://api.simplekpi.com/v1

Endpoints

Name	Type	Read Only	Mandatory	Max Len.	Notes
`id`	integer (16 bit)	yes	no		The value to send as icon_id on a KPI.
`name`	string	yes	no		The icon's display name.

GET /v1/kpiicons

Requires kpis:read on the API key.

curl https://api.simplekpi.com/v1/kpiicons \
  -H "Authorization: Bearer skpi_your_api_key"

Status: 200 OK
[
  {
    "id": 1,
    "name": "Bar chart"
  }
]

GET /v1/kpiicons/{id}

Requires kpis:read on the API key.

Name	Type	Required	Default	Notes
`id`	integer	yes		The icon to return.

curl https://api.simplekpi.com/v1/kpiicons/{id} \
  -H "Authorization: Bearer skpi_your_api_key"