tenantMuteStats

get

tenantMuteStats

Finds common action summaries (Mute %) of calls based on different query filters. This can be used to identify user behavior patterns and possibly environmental or training needs by analyzing: Muted state as a % of total call time. Mute % Data displayed is the cumulative percentage of the total call time that the user was muted during a given call. There are 4 levels of Mute % identified: High: >75% of total call time muted, Moderate: 10-75% of total call time muted, Rare: 1-10% of total call time muted, Never: 0% of total call time muted. NOTE: Mute % and Volume behaviors performed on a deskphone will not be included in this report.
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

https://oda-sandbox.plantronicsmanager.com /reports/usage/commonactions/tenant/{tenantApiCode}/muteusage

Query Parameters


Name Values Description
apikey
(required)

Key to access this api.

muteUsageLevel
(required)

Filter call mute stats for calls having HIGH, RARE, NEVER, MODERATE levels

username

User name queried for mute statistics

userGroups

User group of the device/s

deviceId

device unique identifiers

softphone

Softphone names e.g. Skype, Jabra etc.

product

Product names e.g. DA80 etc. For supported products, take a look at products API

callStartFromDateTime
(required)

Start date time for the query for call start time. Date time are specified in the ISO 8601 YYYY-MM-DDThh:mm:ss.sZ date time format.

callEndToDateTime
(required)

End date time for the query for call start time. 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)

Unique Id for the App

Request Body

tenantApiCode ID of the tenant; Should be a valid hexa decimal 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 token error.

  • 404
    404

    No device entity could be found for the requested device path parameters

Resource Summary

Security

Content Type

application/json

Category

Usage Analysis

Working...