KPI Frequencies

The KPI frequencies determine the KPI data entry frequency.

KPI Frequency Object

The object has the following properties:

Name Type Read Only Mandatory Max 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/Waytobi.App.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://app.waytobi.com/api/kpifrequencies
  -v -u {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://app.waytobi.com/api/kpifrequencies/{id}
  -v -u {token}

Example Response

Status: 200 OK
{
  "id": "D",
  "name": "Daily"
}
 

Unable to find an answer?

Looking for anything specific article which resides in general queries? Just browse the various relevant folders and categories and then you will find the desired article.

Contact Us