Webex · Schema

MeetingUsageReportObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
meetingId	string	Unique identifier for the meeting.
meetingNumber	string	Meeting number.
meetingTitle	string	Meeting title.
start	string	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.
end	string	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	number	Duration of the meeting in minutes.
scheduledType	string	Scheduled type for the meeting. * `meeting` - Regular meeting. * `webinar` - Webinar meeting.
hostDisplayName	string	Display name for the meeting host.
hostEmail	string	Email address for the meeting host.
totalPeopleMinutes	number	Aggregated attendee minutes.
totalCallInMinutes	number	Aggregated attendee PSTN call-in minutes.
totalCallOutDomestic	number	Aggregated attendee domestic PSTN call-out minutes.
totalCallInTollFreeMinutes	number	Aggregated attendee toll-free PSTN call-in minutes.
totalCallOutInternational	number	Aggregated attendee international PSTN call-out minutes.
totalVoipMinutes	number	Aggregated attendee VoIP minutes.
totalParticipants	number	Total number of participants of the meeting.
totalParticipantsVoip	number	Total number of VoIP participants of the meeting.
totalParticipantsCallIn	number	Total number of PSTN call-in participants of the meeting.
totalParticipantsCallOut	number	Total number of PSTN call-out participants of the meeting.
peakAttendee	number	Peak number of attendees throughout the meeting.
totalRegistered	number	Total number of registrants of the meeting.
totalInvitee	number	Total number of invitees of the meeting.
serviceType	string	The service type for the meeting usage report. * `MeetingCenter` - The service type for the usage report is meeting. * `EventCenter` - The service type for the usage report is the event. * `TrainingCe
trackingCodes	array	Tracking codes of the meeting.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MeetingUsageReportObject",
  "title": "MeetingUsageReportObject",
  "type": "object",
  "properties": {
    "meetingId": {
      "type": "string",
      "example": "089b137c3cf34b578896941e2d49dfe8_I_146987372776523573",
      "description": "Unique identifier for the meeting."
    },
    "meetingNumber": {
      "type": "string",
      "example": "123456789",
      "description": "Meeting number."
    },
    "meetingTitle": {
      "type": "string",
      "example": "John's Meeting",
      "description": "Meeting title."
    },
    "start": {
      "type": "string",
      "example": "2023-01-18T10:26:30+08:00",
      "description": "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."
    },
    "end": {
      "type": "string",
      "example": "2023-01-18T10:46:30+08:00",
      "description": "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": {
      "type": "number",
      "example": 20,
      "description": "Duration of the meeting in minutes."
    },
    "scheduledType": {
      "type": "string",
      "enum": [
        "meeting",
        "webinar"
      ],
      "description": "Scheduled type for the meeting.\n * `meeting` - Regular meeting.\n * `webinar` - Webinar meeting.\n"
    },
    "hostDisplayName": {
      "type": "string",
      "example": "John Andersen",
      "description": "Display name for the meeting host."
    },
    "hostEmail": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address for the meeting host."
    },
    "totalPeopleMinutes": {
      "type": "number",
      "example": 60,
      "description": "Aggregated attendee minutes."
    },
    "totalCallInMinutes": {
      "type": "number",
      "example": 60,
      "description": "Aggregated attendee PSTN call-in minutes."
    },
    "totalCallOutDomestic": {
      "type": "number",
      "example": 60,
      "description": "Aggregated attendee domestic PSTN call-out minutes."
    },
    "totalCallInTollFreeMinutes": {
      "type": "number",
      "example": 60,
      "description": "Aggregated attendee toll-free PSTN call-in minutes."
    },
    "totalCallOutInternational": {
      "type": "number",
      "example": 60,
      "description": "Aggregated attendee international PSTN call-out minutes."
    },
    "totalVoipMinutes": {
      "type": "number",
      "example": 60,
      "description": "Aggregated attendee VoIP minutes."
    },
    "totalParticipants": {
      "type": "number",
      "example": 30,
      "description": "Total number of participants of the meeting."
    },
    "totalParticipantsVoip": {
      "type": "number",
      "example": 10,
      "description": "Total number of VoIP participants of the meeting."
    },
    "totalParticipantsCallIn": {
      "type": "number",
      "example": 10,
      "description": "Total number of PSTN call-in participants of the meeting."
    },
    "totalParticipantsCallOut": {
      "type": "number",
      "example": 10,
      "description": "Total number of PSTN call-out participants of the meeting."
    },
    "peakAttendee": {
      "type": "number",
      "example": 30,
      "description": "Peak number of attendees throughout the meeting."
    },
    "totalRegistered": {
      "type": "number",
      "example": 30,
      "description": "Total number of registrants of the meeting."
    },
    "totalInvitee": {
      "type": "number",
      "example": 30,
      "description": "Total number of invitees of the meeting."
    },
    "serviceType": {
      "type": "string",
      "enum": [
        "MeetingCenter",
        "EventCenter",
        "TrainingCenter",
        "SupportCenter"
      ],
      "description": "The service type for the meeting usage report.\n * `MeetingCenter` - The service type for the usage report is meeting.\n * `EventCenter` - The service type for the usage report is the event.\n * `TrainingCenter` - The service type for the usage report is the training session.\n * `SupportCenter` - The service type for the usage report is the support meeting.\n"
    },
    "trackingCodes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MeetingUsageReportTrackingCodeObject"
      },
      "description": "Tracking codes of the meeting."
    }
  }
}