Historical Data related to Room Devices
Returns daily aggregates of various metrics related to Room Devices.
The base URL for these APIs is analytics.webexapis.com, which does not work with the Try It feature.
GET/v1/analytics/roomDeviceMetrics/dailyTotals
Query Parameters
from
string
Starting UTC Date from which historical data should be returned.
Default: Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned.
to
string
Ending UTC Date for which data should be returned.
Default: Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain.
Response Properties
startDate
string
Data is returned starting from this UTC date.
endDate
string
Data is returned up to this UTC date.
metrics
object
dates
string
An Array containing the UTC dates for which the data is returned
totalActiveDevices
string
An array containing the aggregated values for each day for which the data is returned.
totalAssistantCommands
string
totalUsageHours
string
incallUsageDuration
string
signageUsageDuration
string
usbpassthroughUsageDuration
string
whiteboardingUsageDuration
string
video
string
sharing
object
localsharingcableUsageDuration
string
localsharingwirelessUsageDuration
string
recording
string
audio
string
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
GET
/v1/analytics/roomDeviceMetrics/dailyTotals{?from,to}
Log in to try the API.
Header
Query Parameters
- Starting UTC Date from which historical data should be returned.
- Ending UTC Date for which data should be returned.
https://analytics.webexapis.com/v1/analytics/roomDeviceMetrics/dailyTotals?from=2020-08-01&to=2020-08-03
200 / OK
{
"startDate": "2020-08-01",
"endDate": "2020-08-03",
"metrics": {
"dates": "['2020-08-01','2020-08-02']",
"totalActiveDevices": "[200,300]",
"totalAssistantCommands": "[2,3]",
"totalUsageHours": "[100,100]",
"incallUsageDuration": "[50,50]",
"signageUsageDuration": "[1,1]",
"usbpassthroughUsageDuration": "[1,2]",
"whiteboardingUsageDuration": "[3,4]",
"video": "",
"sharing": {
"localsharingcableUsageDuration": "[1,1]",
"localsharingwirelessUsageDuration": "[2,2]"
},
"recording": "",
"audio": ""
}
}