tenantTwaReportsGetUsingGET

Set Admin Credentials...
tenantTwaReportsGetUsingGET

GET

tenantTwaReportsGetUsingGET

The API allows to query twa reports based on periodic noise exposure calculations. It allows querying for twa reports which have a range of dB exposure. NOTE: greaterThanPostLimiterDosage should be < lessThanPostLimiterDosage value.

RELATED INSIGHTS
Investigate summarized calls (across the organization) or individual calls (by username) to view detailed characteristics revealing conversation health. Identify instances where users may be experiencing intentional limiting of headset volume based on Time-Weighted Average (TWA), a Plantronics feature designed to protect individuals from extended levels of volume over the work day.

TERMINOLOGY
  • Potential Dosage: The accumulated noise exposure that would have been experienced over the course of the day without Plantronics Soundguard technologies or G616 protections in place.
  • Actual Dosage: The accumulated noise exposure actually experienced over the course of the day due to Plantronics Soundguard technologies or G616 protections.
  • Exposure Limit: The recommended maximum noise exposure experienced at any time during the day.
  • Potential Exposure: The maximum level of noise exposure that would have been experienced during a 10 minute period of the day without Plantronics Soundguard technologies or G616 protections.
  • Actual Exposure: The maximum level of noise exposure that was actually experienced during a 10 minute period of the day without Plantronics Soundguard technologies or G616 protections.

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.

Resource URL

https://oda-sandbox.plantronicsmanager.com /reports/acousticanalysis/tenant/{tenantApiCode}/noiseexposure

Query Parameters

Name Values Description
apikey
(required)

Key to access this api.
greatEqPreLimiterDosage
(required)

Greater than or equal to the dosage value for hourly exposure before G616 protections.
lessEqPreLimiterDosage
(required)

Less than or equal to the dosage value dosage value for hourly before G616 protections.
username

User name queried for mute statistics
userGroup

User group of the device/s for the twa report.
deviceId

device unique identifiers
reportStartFromDateTime
(required)

The start date/time for which the daily noise exposure is calculated. This should always be set to the start of a given hour in UTC. ISO 8601 format
reportEndToDateTime
(required)

The end date/time for which the daily noise exposure is calculated. This should always be set to the start of a given hour in UTC. ISO 8601 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 Tenant Api code 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 mal formed 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 api code 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...