Jump to

• Request
• Response

Get KPI data

get

/rest/{version}/statistics/kpis

This API retrieves KPI data. Using the hypermedia links returned in the discovery API (endpoint /statistics/kpiTypes), clients can retrieve the KPI data for a particular KPI "type". This will return all the KPI data values of the specified KPI type.

Request

Path Parameters

• version(required):
  REST API version string.
  Available values: v1.2

Query Parameters

• type(required):
  This parameter specifies the KPI "type" to be retrieved. The KPI "type" is a set of related KPIs. Specifying this parameter will return all of the KPI data values of that particular "type". Use the parameter with a valid KPI type string.
  Note - The valid KPI types can be discovered using the KPI discovery API (/statistics/kpiTypes).

Header Parameters

• Authorization(required):
  The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

Back to Top

Response

200 Response

KPI Data response - This is the response model when retrieving KPI data.

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

404 Response

Resource not found

Back to Top