tenantDeviceAdoption

get

tenantDeviceAdoption

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:
  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

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

Query Parameters


Name Values Description
apikey
(required)

Key to access this api.

deviceState

Device state; Please refer documentation on device states

productName

Product Name e.g. BT300

lastSeenStartTime

Start date time for when the device was last seen filter. Date time are specified in the ISO 8601 YYYY-MM-DDThh:mm:ss.sZ date time format.

lastSeenEndTime

End date time for when the device was last seen filter. 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)

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 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...