REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 9.3.0

Get KPI data

get

https://{managementIp}/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): string

REST API version string.
Available values: v1.2

Allowed Values: [ "v1.2" ]

Query Parameters

type(required): string

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.

There's no request body for this operation.

Response

Supported Media Types

application/xml

200 Response

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

Root Schema : response

Type: object

Show Source

data(required): object data

KPI data. There can be one or more KPIs in the <data> object.
links(required): array links
messages(required): object messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "description":"KPI data. There can be one or more KPIs in the &lt;data&gt; object.",
            "type":"object",
            "properties":{
                "(actual containerName)":{
                    "description":"This is a KPI container. The name of the tag is shown in  parentheses because it is variable and dependent on the actual container name. It may or may not be the same as the type depending on the KPI type specified. Some types may have multiple containers.",
                    "type":"object",
                    "properties":{
                        "(actual KPI name)":{
                            "description":"This is the KPI name. The name of the tag is shown in  parentheses because it is variable and dependent on the actual KPI. The value enclosed by this tag is also shown in parentheses because it is variable and its value is the actual KPI data value.",
                            "type":"string",
                            "example":"(Actual KPI value)"
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"Link to related KPI schema to match the KPI data response",
                        "type":"string",
                        "example":"https://{managementIp}/rest/v1.1/statistics/kpiTypes?type=sessCapacityUtil"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

KPI data. There can be one or more KPIs in the <data> object.

Show Source

(actual containerName): object (actual containerName)

This is a KPI container. The name of the tag is shown in parentheses because it is variable and dependent on the actual container name. It may or may not be the same as the type depending on the KPI type specified. Some types may have multiple containers.

{
    "description":"KPI data. There can be one or more KPIs in the &lt;data&gt; object.",
    "type":"object",
    "properties":{
        "(actual containerName)":{
            "description":"This is a KPI container. The name of the tag is shown in  parentheses because it is variable and dependent on the actual container name. It may or may not be the same as the type depending on the KPI type specified. Some types may have multiple containers.",
            "type":"object",
            "properties":{
                "(actual KPI name)":{
                    "description":"This is the KPI name. The name of the tag is shown in  parentheses because it is variable and dependent on the actual KPI. The value enclosed by this tag is also shown in parentheses because it is variable and its value is the actual KPI data value.",
                    "type":"string",
                    "example":"(Actual KPI value)"
                }
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"Link to related KPI schema to match the KPI data response",
                "type":"string",
                "example":"https://{managementIp}/rest/v1.1/statistics/kpiTypes?type=sessCapacityUtil"
            }
        }
    }
}

Nested Schema : messages

Type: object

Nested Schema : (actual containerName)

Type: object

This is a KPI container. The name of the tag is shown in parentheses because it is variable and dependent on the actual container name. It may or may not be the same as the type depending on the KPI type specified. Some types may have multiple containers.

Show Source

(actual KPI name): string

This is the KPI name. The name of the tag is shown in parentheses because it is variable and dependent on the actual KPI. The value enclosed by this tag is also shown in parentheses because it is variable and its value is the actual KPI data value.

Example: (Actual KPI value)

{
    "description":"This is a KPI container. The name of the tag is shown in  parentheses because it is variable and dependent on the actual container name. It may or may not be the same as the type depending on the KPI type specified. Some types may have multiple containers.",
    "type":"object",
    "properties":{
        "(actual KPI name)":{
            "description":"This is the KPI name. The name of the tag is shown in  parentheses because it is variable and dependent on the actual KPI. The value enclosed by this tag is also shown in parentheses because it is variable and its value is the actual KPI data value.",
            "type":"string",
            "example":"(Actual KPI value)"
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

Link to related KPI schema to match the KPI data response

Example: https://{managementIp}/rest/v1.1/statistics/kpiTypes?type=sessCapacityUtil

{
    "type":"object",
    "properties":{
        "link":{
            "description":"Link to related KPI schema to match the KPI data response",
            "type":"string",
            "example":"https://{managementIp}/rest/v1.1/statistics/kpiTypes?type=sessCapacityUtil"
        }
    }
}

400 Response

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

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

401 Response

Unauthorized - Request lacks valid authentication credentials.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

404 Response

Resource not found

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

curl
Python

The following example shows how to get KPI data using curl.

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

The following example shows how to get KPI data using Python.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.2/statistics/kpis?type=sysMemoryUtil"
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>
    <sysMemoryUtil>
      <percentUsed>17</percentUsed>
    </sysMemoryUtil>
  </data>
  <messages/>
  <links>
    <link>https://${SBCIP}/rest/v1.2/statistics/kpiTypes?type=sysMemoryUtil</link>
  </links>
</response>