1. REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 9.3.0
  2. Tasks
  3. statistics

Discover available KPI types or get the KPI schema for a type.

get

https://{managementIp}/rest/{version}/statistics/kpiTypes

This API provides multiple purposes.

  1. KPI discovery -- This API can discover the list of available KPI "types" on the system and the names of the KPIs associated with that type. This discovery API uses the REST HATEOAS technique to return a list of hypermedia (hyperlinks and data) of available KPI types which can be invoked in subsequent REST requests. Through discovery, clients can learn the URL and method of the available resource endpoints that can be invoked. These are returned in the <links> section of the response, as <link> elements. Only KPIs supported via REST can be discovered with this API.

    Therefore, to retrieve the KPI discovery response, use the API without the "type" parameter.

  2. KPI metadata -- This API can retrieve the KPI metadata (schema). Using the hypermedia links returned in the discovery API (described above), clients can invoke the specific endpoint to retrieve the KPI metadata for a particular KPI "type". This will return the schema for each of the KPI data values associated with that KPI type.

    Therefore, to retrieve the KPI metadata (schema) response, use the API with the "type" parameter.

Request

Path Parameters
Query Parameters
  • This parameter specifies the KPI metadata "type" to be retrieved. The KPI "type" is a set of related KPIs. Specifying this parameter will return the KPI metadata response, which contains the KPI metadata (schema) for each of the KPI data values of associated with that KPI type. Use the "type" parameter with a valid KPI type string.
    Note - The valid KPI types can be discovered using the KPI discovery API, which is this API without the "type" parameter.
Header Parameters
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful for KPI metadata or KPI discovery.
Body ()
Root Schema : schema
Match One Schema
Show Source
  • This is the response model when the API is used to retrieve the KPI metadata (schema). The API is used with the "type" parameter to get this response.
  • This is the response model when the API is used to discover the list of available KPI types. The API is used without the "type" parameter to get this response.

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

401 Response

Unauthorized - Request lacks valid authentication credentials.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

404 Response

Resource not found
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

The following example shows how to discover available KPI types or get the KPI schema for a type. using curl.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.2/statistics/kpiTypes"

The following example shows how to discover available KPI types or get the KPI schema for a type. using Python.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.2/statistics/kpiTypes"
resp = requests.get(url, headers=headers)

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data/>
  <messages/>
  <links>
    <link>https://${SBCIP}/rest/v1.2/statistics/kpiTypes?type=globalSessions</link>
    <link>https://${SBCIP}/rest/v1.2/statistics/kpiTypes?type=sessCapacityUtil</link>
    <link>https://${SBCIP}/rest/v1.2/statistics/kpiTypes?type=sipRegistrations</link>
    <link>https://${SBCIP}/rest/v1.2/statistics/kpiTypes?type=sysCPUUtil</link>
    <link>https://${SBCIP}/rest/v1.2/statistics/kpiTypes?type=sysMemoryUtil</link>
  </links>
</response>
Back to Top