The Tech Insights Monitoring Query API - Information Queries

wxpIntroduction

This document aims to show the usage of the Tech Insights Monitoring Query API when using the queries related to calls, endpoints, systems, meetings and trunks.

These calls are illustrated by means of examples provided as Postman calls - it is assumed that the reader is familiar with Postman before starting. The examples comprise an integral part of this document.

How Postman is Used

The examples are provided, attached to this article, as a Postman Collection and a Postman Environment. The purpose of the environment file is two-fold

1. When performing the Authorization function (see How Do I Authenticate to use the Query Service API?) the authorization token is captured as a variable and re-used in all of the subsequent tests. Once the token has expired, all that is necessary is to re-run the authorization step to obtain and store a new token.

2. Many of the API calls require time and/or identification parameters. These can either be set in the environment file or can be obtained from the results of a previous call by highlighting the desired value and right-clicking.

See Using Data Variables for more information.

Tech Insights Monitoring API Queries and Responses

Path Parameters

All request parameters are sent as URL path parameters, with the exception of the Authorization query, which is the only query to use the request body (payload).

Query Responses

All responses are returned as JSON documents.

At the head of the actual content, a header section provides information regarding result set size, pagination etc. The values returned are

totalCount, totalPages, pageNumber, pageSize, and limitReached

limitReached is a boolean value that indicates whether the request returned too many results to be processed as a single result-set. Should this be true then the request will need to be filtered.

The other values are integers - it should be noted that page numbering is zero based.

The other information is returned in a content array:

{
"totalCount": 500,
"totalPages": 25,
"pageNumber": 0,
"pageSize": 20,
"limitReached": true,
"content": [
{
"day": "2020-03-09",
...
}
{ ... }
]
}

Query Parameters - options

Queries can be refined with options passed as URL queries.

The common options are:

Other values are specified per-query. All relevant options are documented in the Postman query.

Filtering

A filter, when available can be set on any value within a result set - filters may be chained with a semi-colon (;) - the resulting filter is a logical AND of the chain.

The following operators can be used in filters:

As an example, a filter of

target==BlueJeans;quality==GOOD 

would return the BlueJeans calls with good quality. A filter of

target==Blue*;quality==GOOD

Will return the same, along with any other calls matching a target beginning Blue.

How to Use the Examples

In order to use the examples, first configure the environment with your credentials and organization ID. If you do not know your organization ID then please raise a helpdesk ticket and request that WXP Collaboration provide this.

Once configured, run the Authorization query in the Postman Connection - this will set your access token as a variable in the environment. Please note that the token is valid for 300 seconds (5 minutes) only, and the Authorisation step must be repeated in order to obtain a new token.

Setting a windowStart and windowEnd will allow you to perform the initial tests. These values are dates in ISO format - examples are present in the environment file.

It is suggested that you run the examples that interest you - setting any values needed from previous results - for instance, running the Get Calls query to obtain the callID and startTime values needed for Get Call Details.

The Examples and Environment

Each example contains all of the relevant query parameters, with description.

The environment file contains the following values: -

Returned results for the examples are described in Tech Insights Monitoring API - Query Responses

The examples provided are as follows: -

Contact Us

For any assistance, create a support case or email support@wxp.hp.com.