Historical Data related to Meetings
Return aggregates of various metrics related to meetings for a given Webex site over a specified time range.
The base URL for these APIs is analytics.webexapis.com, which does not work with the Try It feature.
Query Parameters
URL of the Webex site for which historical data is requested.
UTC Date starting from which the data needs to be returned
UTC Date up to which the data needs to be returned
Response Properties
Site related to which the data is returned.
UTC start date of the data set.
UTC end date of the data set.
Total number of meetings held over the selected date range. includes Webex Meetings, Webex Events, Webex Support, and Webex Training sessions
Total number of joins by participant and devices from all Webex meetings over the selected date range
Total number of unique hosts who started at least one webex meeting over the selected date range
Total number of minutes for all meetings over selected date range
Total number of VoIP and telephony minutes used during meetings over the selected date range
Total number of meetings held where at least one participant enabled video for any amount of time
Total number of meetings held where at least one participant enabled sharing for any amount of time
Total number of meetings held where at least one participant enable recording for any amount of time
Participant Count for each join/client type. This list is dynamic and can change
Participant Count for each Role
Participant Count for each Location. This is a json array of countries
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. |
Header
Query Parameters
- URL of the Webex site for which historical data is requested.
- UTC Date starting from which the data needs to be returned
- UTC Date up to which the data needs to be returned
{
"siteUrl": "cisco.webex.com",
"startDate": "2020-08-01",
"endDate": "2020-08-03",
"metrics": {
"totalMeetings": 123,
"totalParticipants": 123,
"totalUniqueHosts": 123,
"totalMeetingMinutes": 1234,
"totalAudioMinutes": 1234,
"totalTelephoneMinutes": 1234,
"totalVoIPMinutes": 1234,
"videoMeetings": 123,
"sharingMeetings": 123,
"recordingMeetings": 123,
"participantsByJoinMethods": {
"webApp": 123,
"cloudVideoDevice": 123,
"mobileMeetingsApp": 123
},
"participantsByRoles": {
"host": 123,
"attendee": 123
},
"participantsByLocation": [
{
"country": "United States",
"totalParticipants": 123
}
]
}
}