1. REST API for Session Border Controller Release 8.3
  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 (KPI discovery) 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.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object

200 (KPI metadata) Response

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.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: array
KPIs metadata (schemas)
Show Source
Nested Schema : messages
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : kpis
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : kpi
Type: object
KPI metadata (schema).
Show Source
  • Allowed Values: [ "integer", "number" ]
    KPI data type
    Example: integer
  • KPI description
    Example: The percentage of session capacity utilization
  • Allowed Values: [ "counter", "gauge" ]
    Metric type. Counter and gauge types are supported. Counters KPIs cumulative metrics that only increase in value or get reset to zero. Gauge KPIs are numerical values that can increase or decrease.
    Example: integer
  • KPI name
    Example: percentCap
  • Allowed Values: [ "bytes", "calls", "calls per second", "messages", "messages per second", "percent", "seconds" ]
    KPI units of measurement. This will be empty if there are no units of measurement for the data.
    Example: percent

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

Example of Accessing the API with cURL

The following example shows how to discover available KPI types or get the KPI schema for a type. by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://10.0.0.2/rest/v1.1/statistics/kpiTypes"

Example of Accessing the API with Python

The following example shows how to discover available KPI types or get the KPI schema for a type. by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate. 

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

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 15 Jan 2019 15:38:20 GMT
Cache-Control: no-cache
Content-Length: 549
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Tue, 15 Jan 2019 15:38:20 GMT
X-Appweb-Seq: 161

Example of the Response Body

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

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