Specific Performance Monitoring Parameters

Use the following URL to retrieve the specific performance monitoring data.

The following attributes are specified for the last interval:

■

id – performance monitoring name

■

value

URL

■

Singular entities:

/api/v1/kpi/current/<app>/<group>/<ent>/<kpi>
/api/v1/kpi/history/<app>/<group>/<ent>/<kpi>?interval=<idx>

■

Indexed entities:

/api/v1/kpi/current/<app>/<group>/<ent>/<id>/<kpi>
/api/v1/kpi/history/<app>/<group>/<ent>/<id>/<kpi>?interval=<idx>

HTTP Method

GET

Supported Parameters

Parameter	Type	Description
?interval=<Index>	Number	Returns the performance monitoring parameter's value for the specified interval.
?interval=last	String	Returns the performance monitoring parameter's value for the last (most recent) measurement interval.
?interval=all	String	Returns the performance monitoring parameter's values for all measurement intervals.
?detailed=true|false	String	When it equals false (default is enabled) some fields are not returned in the response (e.g., name and description).

HTTP Responses

■

200 OK

■

204 Bad Request – nothing to display

■

404 Not Found – invalid path

Example 1

■

Request:

GET / /api/v1/kpi/current/sbc/callStats/ipGroup/0/noAnswerCallsInTotal HTTP/1.1
Host: 10.4.219.229

■

Response:

 HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": "noAnswerCallsInTotal ",
    " value": 10
}

Example 2

■

Request:

GET / /api/v1/kpi/current/sbc/callStats/ipGroup/0/noAnswerCallsInTotal ?interval=all HTTP/1.1
Host: 10.4.219.229

■

Response:

 HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "interval": "21",
            "value": "0"
        },
        {
            "interval": "20",
            "value": "0"
        },
        {
            "interval": "19",
            "value": "0"
        }
     ]
}