tenantLinkQuality

get

tenantLinkQuality

Returns the link quality summary metrics. This can be used to identify cases where the quality of the radio communication link between computer and headset is poor and may be an indication of system issues and help troubleshoot the call quality issues (e.g. particular groups, product types, locations, etc.). Quality Impairment Score (QIS) is a measure of the user’s average call quality based on the percentage of packet errors and related data. The higher the impairment score, the lower the quality of the user’s average call experience. For example, a QIS of 0 for a given user would indicate that all calls were free from any detectable errors, while a QIS of 100 for a user would indicate that all calls suffered a complete loss of call audio.
This dataset is addressing the details. tenantApiCode value of "af0813e6-81c0-4a77-89d2-3338d0277c42" and apikey value of "1hKMMPFMmaldnC0rcohvXN0UX7UeWPjb" can be used as url parameters to test this api for accessing sample data.
Note:
  1. The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only.
  2. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant.
  3. Please register here http://developer.plantronics.com/user/register and generate your apikey for apps when you are ready to integrate with a production tenant data and your app.  

Resource URL

http://plantronics-sandbox.apigee.net /reports/conversationanalysis/tenant/{tenantApiCode}/linkquality

Query Parameters


Name Values Description
apikey
(required)

Key to access this api.

isAggregated
(required)

Aggregated or raw events; Aggregated would summarize at each call level in the given time range.

username

User name of the conflicts

userGroups

User group of the device/s

deviceId

Array of devices; Devices should be a valid display id of a Plantronics device

softphone

A valid softphone name e.g. Skype

productFamily

A valid Plantronics product family like DA Series

productName

A valid Plantronics product name like DA 80

callStartTime
(required)

Start date time for when the conflict was last seen filter. Date time are specified in the ISO 8601 YYYY-MM-DDThh:mm:ss.sZ date time format.

callEndTime
(required)

End date time for when the conflict was last seen filter. Date time are specified in the ISO 8601 YYYY-MM-DDThh:mm:ss.sZ date time format.

page
(required)

Page of the result

count
(required)

count or number of results in a page


Header Parameters


Name Values Description
appId
(required)

Application Unique Id

Request Body

tenantApiCode ID of the tenant; Should be a valid hexadecimal af0813e6-81c0-4a77-89d2-3338d0277c42 true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Generic malformed request.

  • 422
    422

    One or more of the required parameters not found in the request URI.

  • 401
    401

    Unauthorized

  • 500
    500

    Internal server error.

  • 403
    403

    Unauthorized app error.

  • 404
    404

    No device entity could be found for the requested path parameters

Resource Summary

Security

Content Type

application/json

Category

Conversation Analysis

Working...