APIs
Getting StartedREST API BasicsComplianceWebhooksAPI Changelog
Admin
Calling
Contact Center
Devices
imiconnect
Meetings
Messaging
Webex Assistant Skills
Full API Reference

Historical Data related to Meetings

Return aggregates of various metrics, related to meetings, for the siteUrl and over the time range specified by the user

GET/v1/analytics/meetingsMetrics/aggregates
Query Parameters
siteUrl
stringrequired

Site related to which the data is expected. This parameter is required

from
string

UTC Date starting from which the data needs to be returned

Default: Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided
to
string

UTC Date till which the data needs to be returned

Default: Data from the date mentioned in 'from' parameter till yesterday if 'to' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided. Yesterday would be as late as the data would go
Response Properties
siteUrl
string

Site related to which the data is returned

startDate
string

Data is returned starting from this UTC date

endDate
string

Data is returned till this UTC date

metrics
object
totalMeetings
number

Total number of meetings held over the selected date range. includes Webex Meetings, Webex Events, Webex Support, and Webex Training sessions

totalParticipants
number

Total number of joins by participant and devices from all Webex meetings over the selected date range

totalUniqueHosts
number

Total number of unique hosts who started atleast one webex meeting over the selected date range

totalMeetingMinutes
number

Total number of minutes for all meetings over selected date range

totalAudioMinutes
number

Total number of VoIP and telephony minutes used during meetings over the selected date range

totalTelephoneMinutes
number
totalVoIPMinutes
number
videoMeetings
number

Total number of meetings held where at least one participant enabled video for any amount of time

sharingMeetings
number

Total number of meetings held where atleast one participant enabled sharing for any amount of time

recordingMeetings
number

Total number of meetings held where atleast one participant enable recording for any amount of time

participantsByJoinMethods
object

Participant Count for each join/client type. This list is dynamic and can change

webApp
number
cloudVideoDevice
number
mobileMeetingsApp
number
participantsByRoles
object

Participant Count for each Role

host
number
attendee
number
participantsByLocation
array[object]

Participant Count for each Location. This is a json array of countries

country
string
Possible values: United States
totalParticipants
number
Possible values: 123
Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/analytics/meetingsMetrics/aggregates{?siteUrl,from,to}
Log in to try the API.
Header
Query Parameters
  • Site related to which the data is expected. This parameter is required
  • UTC Date starting from which the data needs to be returned
  • UTC Date till which the data needs to be returned
https://analytics.webexapis.co/v1/analytics/meetingsMetrics/aggregates?siteUrl=cisco.webex.com&from=2020-08-01&to=2020-08-03
200 / OK
{
  "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
      }
    ]
  }
}