callsummaryCD

get

callsummaryCD

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:
  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/conversationanalysis/tenant/{tenantApiCode}/cdevents

Query Parameters


Name Values Description
apikey
(required)

Key to access this api.

deviceId
(required)

Array of devices display ID of the device as seen on Plantronics Hub e.g. 0AGTL8

startDate
(required)

Start date time for the query for call level conversation dynamic statistics. ISO 8601 format

endDate
(required)

End date time for the query for call level conversation dynamic statistics. ISO 8601 format

aggregateLevel
(required)

Aggregation level parameter; Valid values can be 'summary' or 'device'; Default is device

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 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 mal formed 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

Conversation Analysis

Working...