Set of APIs to access various datasets exposed by Plantronics.

Usage Analysis

Method
Description

GET

tenantCallsummary

http://plantronics-sandbox.apigee.net/reports/usage/tenant/{tenantApiCode}/callsummary

RELATED INSIGHTS Assess and evaluate employee's use of headsets based on calls made and received and the duration of calls made/received (by device). Identify users who use headsets most often to ensure support is available. Identify patterns of user behavior re: headsets to help org determine future product orders.Calls are defined by their "Call End Time" in order to calculate call duration and other values. e.g. A call that begins on April 30 at 11:45pm and ends at 12:15am on May 1 will be recorded as occurring: on May 1 between 12:00am and 1:00am in the daily view with a duration of 30 minutes 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantDeviceAdoption

http://plantronics-sandbox.apigee.net/reports/usage/tenant/{tenantApiCode}/deviceadoption

Finds device adoption patterns. This can be used to identify user adoption of product families, models, or individual devices based on known call activity engaging the device and a specific softphone. DEFINITION OF TERMS: Used in a Call: A call has been made or received within the specified period of time using the device and a specified softphone. Not Used in a Call: No calls have been made or received within the specified period of time using the device and a specified softphone. CONSTRAINTS: Mobile calls are only included in totals when the mobile device is connected to your computer. Device States - All the devices fall into one of the below 3 categories: 1. Active: last detected in past 30 days. 2. Inactive: last detected 31-90 days ago. 3. Out of Service: last detected more than 90 days ago. NOTE1: Must Specify either Device state or Last Seen Start time and End times. NOTE2: If Last Seen Start time and End times are specified, response will display all the products which are last detected in the specified range. NOTE3: If both Device state and Last Seen Start time and End times are specified, Device State will take the priority. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantVolumeAdjustments

http://plantronics-sandbox.apigee.net/reports/usage/commonactions/tenant/{tenantApiCode}/volumeadjustments

Finds common action summaries (Volume adjustment) of calls based on different query filters. This can be used to identify user behavior patterns and possibly environmental or training needs by analyzing: Total # of Volume step events per day. Data displayed is the aggregation of unique volume 'step' adjustments applied via the headset volume button or the softphone volume control on the user's PC during a given period of time. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantQd

http://plantronics-sandbox.apigee.net/reports/usage/commonactions/tenant/{tenantApiCode}/quickdisconnectusage

Finds common action summaries (Quick Disconnect Usage) of calls based on different query filters. This can be used to identify user behavior patterns and possibly environmental or training needs by analyzing: Total # of Quick Disconnect events per day. Quick Disconnect refers to the one-step disconnect functionality provided by specific Plantronics products (e.g. DA Series, Blackwire 5xx). Data displayed is the aggregation of unique 'connect' (make) and 'disconnect' (break) actions performed by the user during a given period of time. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantMuteStats

http://plantronics-sandbox.apigee.net/reports/usage/commonactions/tenant/{tenantApiCode}/muteusage

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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

Streaming

Method
Description

GET

streamsById

http://plantronics-sandbox.apigee.net/realtime/streams/{streamId}

Gets the meta-data for a specific stream types for an app. The meta-data will be used to setup publish and subscription details for the stream for an ingestion or subscription.

GET

streams

http://plantronics-sandbox.apigee.net/realtime/streams

Gets 'Subscription' streams available for an app.

POST

stopStreamUsingPOST

http://plantronics-sandbox.apigee.net/realtime/streams/{streamId}/stop

Stops a new real time stream request to the resource. This initiates stopping a real time stream for computation by ingestion of a raw stream from devices; NOTE: It is not instantaneous and leads to a series of backend systems to be setup. It will enable the system to setup infrastructure to stop the real time streams.

POST

startStreamUsingPOST

http://plantronics-sandbox.apigee.net/realtime/streams/{streamId}/start

Starts a new real time stream request to the resource. This establishes a real time stream for computation by ingestion of a raw stream from devices; NOTE: It is not instantaneous and leads to a series of backend systems to be setup. It will enable the system to setup infrastructure to start the real time streams.

Foundational

Method
Description

GET

productById

http://plantronics-sandbox.apigee.net/foundational/product/{id}

Finds Plantronics product's metadata by id.

GET

productsByModelId

http://plantronics-sandbox.apigee.net/foundational/product/modelId

Returns the plantronics products filtered by modelId

GET

softphones

http://plantronics-sandbox.apigee.net/foundational/softphones

Returns the Plantronics softphones.

GET

tenantUsers

http://plantronics-sandbox.apigee.net/foundational/tenant/{tenantApiCode}/users

Returns the users detected by PM Pro in the organization using headsets.

GET

products

http://plantronics-sandbox.apigee.net/foundational/products

Returns the plantronics product catalog with model names, product family etc.

GET

productsByFamilyId

http://plantronics-sandbox.apigee.net/foundational/product/family/{familyId}

Returns the plantronics product filtered by family id

GET

productFamilies

http://plantronics-sandbox.apigee.net/foundational/product/families

Returns the plantronics product families

GET

productByType

http://plantronics-sandbox.apigee.net/foundational/product/type/{type}

Finds all Plantronics products based on a device type. Returns product metadata of each product.

Asset Analysis

Method
Description

GET

tenantSWVersionStatus

http://plantronics-sandbox.apigee.net/reports/assets/tenant/{tenantApiCode}/versionstatus/software

Finds software version compliance status of a tenant. There are 3 categories of firmware and software versions identified here: Compliant: the device (or computer) is running the firmware (or software) version AS DEFINED by your active policy for that product. Non-Compliant: the device (or computer) is running a firmware (or software) version DIFFERENT from what you have defined in your policy for that product. No Policy: the device (or computer) is currently NOT MANAGED by an active policy. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantSoftphoneStatus

http://plantronics-sandbox.apigee.net/reports/assets/tenant/{tenantApiCode}/softphone/status

Allows querying softphone statuses across organization. This can be helpful to generate insights such as - individual and departmental preferences, identifying current status of softphones, identifying opportunities to converge users' communication tools to realize better support and consistent user experiences. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

deviceById

http://plantronics-sandbox.apigee.net/reports/assets/tenant/{tenantApiCode}/device/{deviceId}

Returns the device inventory based on Id. Id is the tatoo id id of the PLT device if one is available. Otherwise it should be set to deviceId (the genes serial number). If the deviceId is manufactured the field should be excluded from the dataset. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantDeviceInventory

http://plantronics-sandbox.apigee.net/reports/assets/tenant/{tenantApiCode}/devices

Returns the device inventory statistics based on the query filter parameters. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantDetectedConflicts

http://plantronics-sandbox.apigee.net/reports/assets/tenant/{tenantApiCode}/detectedconflicts

Returns the bad detected conflicts in the headset and softphone deployment which may be impacting communication. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantDeviceInventoryByUserGroup

http://plantronics-sandbox.apigee.net/reports/assets/tenant/{tenantApiCode}/devices/usergroup

Returns the device inventory statistics based on the query filter paramters. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantDeviceInventoryByUser

http://plantronics-sandbox.apigee.net/reports/assets/tenant/{tenantApiCode}/devices/user/{username}

Returns the device inventory statistics based on the query filter parameters. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantFWVersionStatus

http://plantronics-sandbox.apigee.net/reports/assets/tenant/{tenantApiCode}/versionstatus/firmware

Finds device firmware version compliance status of a tenant. There are 3 categories of firmware and software versions identified here: Compliant: the device (or computer) is running the firmware (or software) version AS DEFINED by your active policy for that product. Non-Compliant: the device (or computer) is running a firmware (or software) version DIFFERENT from what you have defined in your policy for that product. No Policy: the device (or computer) is currently NOT MANAGED by an active policy. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

Partner App Management

Method
Description

PUT

registerPartnerAppUsingPUT

http://plantronics-sandbox.apigee.net/app

Registers and creates a partner application into the Plantronics platform.

GET

partnerAppById

http://plantronics-sandbox.apigee.net/partner/app/{appId}

Returns app's metadata for a unique app Id.

PUT

requestAppAuthorizationUsingPUT

http://plantronics-sandbox.apigee.net/partner/app/{appId}/authrequests

Adds a request for authorization for the app within PM pro for the requested tenant. tenantApiCode value of "af0813e6-81c0-4a77-89d2-3338d0277c42" can be used in url parameter to test this api.

Conversation Analysis

Method
Description

GET

callsummaryCD

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

Returns the aggregated conversation dynamic summary for a specified device id. The start and end date will be defined by date-time - RFC3339. ISO 8601 format. 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

tenantLinkQuality

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

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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

GET

rawLinkQualityEvents

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

Returns the link quality summary metrics.RELATED INSIGHTS Identify cases where the quality of the radio communication link between computer and headset is poor and may be an indication of system issues. Help troubleshoot the call quality issues (e.g. particular groups, product types, locations, etc.). DEFINITION OF TERMS Quality Impairment Score (QIS) - 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.  

Acoustic Analysis

Method
Description

GET

tenantAcousticIncidents

http://plantronics-sandbox.apigee.net/reports/acousticanalysis/tenant/{tenantApiCode}/acousticevents

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.VENT FILTERS All Events: events mitigated and unmitigated by limiters. All Limited Events: events mitigated by G616 and/or PLT limiters. PLT Limited Events: events mitigated by one or more Plantronics proprietary limiters. G616 Limited Events: events mitigated according to the G616 communications industry standard. PLT & G616 Limited Events: events mitigated by G616 and one or more PLT 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: The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant. 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.