Developer API

KPI Frequencies

The KPI frequencies determine the KPI data entry frequency.

KPI Frequency 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 frequency

JSON Example

{
 "id": "D",
 "name": "Daily"
}

XML Example

<KPIFrequency xmlns="http://schemas.datacontract.org/2004/07/SimpleKPI.Application.Areas.Api.Models" 
         xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>D</id>
  <name>Daily</name>
</KPIFrequency>

 

Get all KPI Frequencies

GET /api/kpifrequencies

Using curl

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

Example Response

Status: 200 OK
[
  {
    "id": "D",
    "name": "Daily"
  },
  {
    "id": "W",
    "name": "Weekly"
  }
]

Get a KPI Frequency

GET /api/kpifrequencies/{id}

Using curl

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

Example Response

Status: 200 OK
{
  "id": 5,
  "name": "Calculator"
}