BackAPI reference
- Overview
- Authentication
- Errors and limits
- Code examples
- Moving from Classic
- KPIs
- KPI Categories
- KPI Categories / KPIs
- Breakdown Items
- KPI Entries
- KPI Frequencies
- KPI Icons
- KPI Units
- Reports
- Users
SimpleKPI AI › API reference
KPI Frequencies
A read-only lookup of how often data can be entered against a KPI. The ids
returned here are what frequency_id on a
KPI accepts.
Read the list rather than hard-coding it — it is a system table and can gain entries.
Base URL https://api.simplekpi.com/v1
Endpoints
- List KPI frequencies —
GET /v1/kpifrequencies - Get a KPI frequency —
GET /v1/kpifrequencies/{id}
KPI frequency object
| Name | Type | Read Only | Mandatory | Max Len. | Notes |
|---|---|---|---|---|---|
id | string | yes | no | The value to send as frequency_id on a KPI. Case sensitive. | |
name | string | yes | no | The frequency's display name, e.g. Weekly. |
List KPI frequencies
GET /v1/kpifrequencies
Requires kpis:read on the API key.
Using curl
curl https://api.simplekpi.com/v1/kpifrequencies \ -H "Authorization: Bearer skpi_your_api_key"
Example response
Status: 200 OK
[
{
"id": "D",
"name": "Daily"
},
{
"id": "W",
"name": "Weekly"
},
{
"id": "M",
"name": "Monthly"
}
]Status codes
| Code | Meaning |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
429 | Too Many Requests |
Get a KPI frequency
GET /v1/kpifrequencies/{id}
Requires kpis:read on the API key.
Parameters
| Name | Type | Required | Default | Notes |
|---|---|---|---|---|
id | string | yes | The frequency code to return, e.g. W. Case sensitive. |
Using curl
curl https://api.simplekpi.com/v1/kpifrequencies/{id} \
-H "Authorization: Bearer skpi_your_api_key"Status codes
| Code | Meaning |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |