List Meeting Usage Reports
List meeting usage reports of all the users on the specified site by an admin. You can specify a date range and the maximum number of meeting usage reports to return.
The list returned is sorted in descending order by the date and time the meetings were started.
Long result sets are split into pages.
siteUrlis required, and the meeting usage reports of the specified site are listed. All available Webex sites can be retrieved by the Get Site List API.
Request Header
timezone: Time zone in conformance with the IANA time zone database. The default timezone isUTCif not defined.
Query Parameters
URL of the Webex site which the API lists meeting usage reports from. All available Webex sites can be retrieved by the Get Site List API.
Meeting usage report's service-type. If serviceType is specified, the API filters meeting usage reports by service-type. If serviceType is not specified, the API returns meeting usage reports by MeetingCenter by default. Valid values:
MeetingCenterEventCenterSupportCenterTrainingCenter
Starting date and time for meeting usage reports to return, in any ISO 8601 compliant format. from cannot be after to. The interval between to and from cannot exceed 30 days and from cannot be earlier than 90 days ago.
Ending date and time for meeting usage reports to return, in any ISO 8601 compliant format. to cannot be before from. The interval between to and from cannot exceed 30 days.
Maximum number of meetings to include in the meetings usage report in a single page. max must be greater than 0 and equal to or less than 1000.
Response Properties
An array of meeting usage report objects.
Unique identifier for the meeting.
Meeting number.
Meeting title.
The date and time when the meeting was started. It's in the timezone specified in the request header or in the UTC timezone if timezone is not specified.
The date and time when the meeting was ended. It's in the timezone specified in the request header or in the UTC timezone if timezone is not specified.
Duration of the meeting in minutes.
Scheduled type for the meeting.
Regular meeting.
Webinar meeting.
Display name for the meeting host.
Email address for the meeting host.
Aggregated attendee minutes.
Aggregated attendee PSTN call-in minutes.
Aggregated attendee domestic PSTN call-out minutes.
Aggregated attendee toll-free PSTN call-in minutes.
Aggregated attendee international PSTN call-out minutes.
Aggregated attendee VoIP minutes.
Total number of participants of the meeting.
Total number of VoIP participants of the meeting.
Total number of PSTN call-in participants of the meeting.
Total number of PSTN call-out participants of the meeting.
Peak number of attendees throughout the meeting.
Total number of registrants of the meeting.
Total number of invitees of the meeting.
The service type for the meeting usage report.
The service type for the usage report is meeting.
The service type for the usage report is the event.
The service type for the usage report is the training session.
The service type for the usage report is the support meeting.
Tracking codes of the meeting.
Name of the tracking code.
Value of the tracking code.
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 which the API lists meeting usage reports from. All available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.
- Meeting usage report's service-type. If `serviceType` is specified, the API filters meeting usage reports by service-type. If `serviceType` is not specified, the API returns meeting usage reports by `MeetingCenter` by default. Valid values: + `MeetingCenter` + `EventCenter` + `SupportCenter` + `TrainingCenter`
- Starting date and time for meeting usage reports to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `to` and `from` cannot exceed 30 days and `from` cannot be earlier than 90 days ago.
- Ending date and time for meeting usage reports to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `to` and `from` cannot exceed 30 days.
- Maximum number of meetings to include in the meetings usage report in a single page. `max` must be greater than 0 and equal to or less than `1000`.
{
"items": [
{
"meetingId": "089b137c3cf34b578896941e2d49dfe8_I_146987372776523573",
"meetingNumber": "123456789",
"meetingTitle": "John's Meeting",
"start": "2023-01-18T10:26:30+08:00",
"end": "2023-01-18T10:46:30+08:00",
"duration": 20,
"scheduledType": "meeting",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"totalPeopleMinutes": 60,
"totalCallInMinutes": 60,
"totalCallOutDomestic": 60,
"totalCallInTollFreeMinutes": 60,
"totalCallOutInternational": 60,
"totalVoipMinutes": 60,
"totalParticipants": 30,
"totalParticipantsVoip": 10,
"totalParticipantsCallIn": 10,
"totalParticipantsCallOut": 10,
"peakAttendee": 30,
"totalRegistered": 30,
"totalInvitee": 30,
"serviceType": "MeetingCenter",
"trackingCodes": [
{
"name": "Department",
"value": "Engineering"
},
{
"name": "Division",
"value": "Web"
}
]
}
]
}