tenantAcousticIncidents

Set Admin Credentials...
tenantAcousticIncidents

GET

tenantAcousticIncidents

Finds acoustic incidents based on different query filters. This can be useful to identify trends related to acoustic events across organization to help troubleshoot causes and provide support for preventative measures. And also to identify occurrence of acoustic events during Plantronics calls that were successfully mitigated by Plantronics devices in order to evaluate employee claims re: workplace noise.

EVENT FILTERS
  • All Events: events mitigated and unmitigated by limiters.
  • All Limited Events: events mitigated by G616 and/or Plantronics limiters.
  • Plantronics Limited Events: events mitigated by one or more Plantronics proprietary limiters. G616 Limited Events: events mitigated according to the G616 communications industry standard.
  • Plantronics & G616 Limited Events: events mitigated by G616 and one or more Plantronics limiters. Non-Limited Events: events unmitigated by limiters.
* NOTE: Filters apply to supported devices only. Although multiple Plantronics products provide acoustic shock protection, this report is currently restricted to displaying data for the "DA Series" of Plantronics devices.

LIMITED LEVELS
  • Initial: the estimated level of the original event prior to mitigation.
  • Actual: the mitigated level actually experienced by the user.
  • Reduction: the total reduction in level due to mitigation.
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/acousticanalysis/tenant/{tenantApiCode}/acousticevents

Query Parameters

Name Values Description
apikey
(required)

Key to access this api.
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 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 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, start from 0

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 hexa decimal af0813e6-81c0-4a77-89d2-3338d0277c42 true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...
Reset
Request Response cURL

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

    Generic malformed request.

  • 422

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

  • 401

    Unauthorized

  • 500

    Internal server error.

  • 403

    Unauthorized token error.

  • 404

    No tenant id can be found for the path parameters

Resource Summary

Security

Content Type

application/json

Category

Health and Safety

Name Type Description
Name Type Description

Working...