openapi: 3.0.0
info:
  title: Webex Admin Address Book Meetings Summary Report API
  version: 1.0.0
  description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Meetings Summary Report
paths:
  /meetingReports/usage:
    get:
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/MeetingUsageReportObject'
                    description: An array of meeting usage report objects.
              example:
                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
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: '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':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: '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':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: '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':
          description: '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':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: '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':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: List Meeting Usage Reports
      operationId: List Meeting Usage Reports
      description: '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](/docs/basics#pagination).


        * `siteUrl` is required, and the meeting usage reports of the specified site are listed. All available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.


        #### Request Header


        * `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default timezone is `UTC` if not defined.'
      tags:
      - Meetings Summary Report
      parameters:
      - name: siteUrl
        in: query
        description: 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.
        required: true
        example: example.webex.com
        schema:
          type: string
      - name: serviceType
        in: query
        description: '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`'
        example: MeetingCenter
        schema:
          type: string
      - name: from
        in: query
        description: 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.
        example: '2023-01-18T00:00:00+08:00'
        schema:
          type: string
          default: If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.
      - name: to
        in: query
        description: 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.
        example: '2023-01-19T00:00:00+08:00'
        schema:
          type: string
          default: If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.
      - name: max
        in: query
        description: 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`.
        schema:
          type: number
          default: 10
      - name: timezone
        in: header
        description: e.g. Asia/Shanghai
        required: false
        schema:
          type: string
        example: Asia/Shanghai
  /meetingReports/attendees:
    get:
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/MeetingAttendeeReportObject'
                    description: An array of meeting attendee report objects.
              example:
                items:
                - meetingId: 089b137c3cf34b578896941e2d49dfe8_I_146987372776523573
                  meetingNumber: '123456789'
                  meetingTitle: John's Meeting
                  displayName: John Andersen
                  email: john.andersen@example.com
                  joinedTime: '2023-01-18T10:26:30+08:00'
                  leftTime: '2023-01-18T10:46:30+08:00'
                  duration: 20
                  participantType: ATTENDEE
                  ipAddress: 172.16.244.151
                  clientAgent: WINDOWS,IE
                  company: ExampleCompany
                  phoneNumber: '85763644'
                  address1: Building 1
                  address2: Street 1
                  city: San Jose
                  state: CA
                  country: US
                  zipCode: '38755'
                  registered: false
                  invited: true
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: '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':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: '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':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: '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':
          description: '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':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: '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':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: List Meeting Attendee Reports
      operationId: List Meeting Attendee Reports
      description: 'Lists of meeting attendee reports by a date range, the maximum number of meeting attendee reports, a meeting ID, a meeting number or a meeting title.


        If the requesting user is an admin, the API returns meeting attendee reports of the meetings hosted by all the users on the specified site filtered by meeting ID, meeting number or meeting title.


        If it''s a normal meeting host, the API returns meeting attendee reports of the meetings hosted by the user himself on the specified site filtered by meeting ID, meeting number or meeting title.


        The list returned is grouped by meeting instances. Both the groups and items of each group are sorted in descending order of `joinedTime`. For example, if `meetingId` is specified and it''s a meeting series ID, the returned list is grouped by meeting instances of that series. The groups are sorted in descending order of `joinedTime`, and within each group the items are also sorted in descending order of `joinedTime`. Please refer to [Meetings Overview](/docs/meetings) for details of meeting series, scheduled meeting and meeting instance.


        Long result sets are split into [pages](/docs/basics#pagination).


        * `siteUrl` is required, and the meeting attendee reports of the specified site are listed. All available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.


        * `meetingId`, `meetingNumber` and `meetingTitle` are optional parameters to query the meeting attendee reports, but at least one of them should be specified. If more than one parameter in the sequence of `meetingId`, `meetingNumber`, and `meetingTitle` are specified, the first one in the sequence is used. Currently, only ended meeting instance IDs and meeting series IDs are supported for `meetingId`. IDs of scheduled meetings or personal room meetings are not supported.


        #### Request Header


        * `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default timezone is `UTC` if not defined.'
      tags:
      - Meetings Summary Report
      parameters:
      - name: siteUrl
        in: query
        description: URL of the Webex site which the API lists meeting attendee reports from. All available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.
        required: true
        example: example.webex.com
        schema:
          type: string
      - name: from
        in: query
        description: Starting date and time for the meeting attendee 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.
        example: '2023-01-18T00:00:00+08:00'
        schema:
          type: string
          default: If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time.
      - name: to
        in: query
        description: Ending date and time for the meeting attendee 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.
        example: '2023-01-19T00:00:00+08:00'
        schema:
          type: string
          default: If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time.
      - name: max
        in: query
        description: Maximum number of meeting attendees to include in the meeting attendee report in a single page. `max` must be greater than 0 and equal to or less than `1000`.
        schema:
          type: number
          default: 10
      - name: meetingId
        in: query
        description: Meeting ID for the meeting attendee reports to return. If specified, return meeting attendee reports of the specified meeting; otherwise, return meeting attendee reports of all meetings. Currently, only ended meeting instance IDs are supported. IDs of meeting series, scheduled meetings or personal room meetings are not supported.
        example: 089b137c3cf34b578896941e2d49dfe8_I_146987372776523573
        schema:
          type: string
      - name: meetingNumber
        in: query
        description: Meeting number for the meeting attendee reports to return. If specified, return meeting attendee reports of the specified meeting; otherwise, return meeting attendee reports of all meetings.
        example: '123456789'
        schema:
          type: string
      - name: meetingTitle
        in: query
        description: Meeting title for the meeting attendee reports to return. If specified, return meeting attendee reports of the specified meeting; otherwise, return meeting attendee reports of all meetings.
        example: John's Meeting
        schema:
          type: string
      - name: timezone
        in: header
        description: e.g. Asia/Shanghai
        required: false
        schema:
          type: string
        example: Asia/Shanghai
components:
  schemas:
    MeetingUsageReportTrackingCodeObject:
      type: object
      properties:
        name:
          type: string
          example: Department
          description: Name of the tracking code.
        value:
          type: string
          example: Engineering
          description: Value of the tracking code.
    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: john.andersen@example.com
          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.
    MeetingAttendeeReportObject:
      type: object
      properties:
        meetingId:
          type: string
          example: 089b137c3cf34b578896941e2d49dfe8_I_146987372776523573
          description: Unique identifier for the meeting.
        meetingNumber:
          type: number
          example: 123456789
          description: Meeting number.
        meetingTitle:
          type: string
          example: John's Meeting
          description: Meeting title.
        displayName:
          type: string
          example: John Andersen
          description: Attendee's display name.
        email:
          type: string
          example: John Andersen
          description: Attendee's email.
        joinedTime:
          type: string
          example: '2023-01-18T10:26:30+08:00'
          description: The date and time when the attendee joined the meeting. It's in the timezone specified in the request header or in the `UTC` timezone if timezone is not specified.
        leftTime:
          type: string
          example: '2023-01-18T10:46:30+08:00'
          description: The date and time when the attendee left the meeting. 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 attendee in the meeting in minutes.
        participantType:
          type: string
          enum:
          - host
          - attendee
          description: "The attendee's role in the meeting.\n * `host` - Meeting host.\n * `attendee` - Meeting attendee.\n"
        ipAddress:
          type: string
          example: 172.16.244.151
          description: IP address of the attendee when he attended the meeting.
        clientAgent:
          type: string
          example: WINDOWS,IE
          description: Information of the attendee's operating system and application when he attended the meeting.
        company:
          type: string
          example: ExampleCompany
          description: Attendee's company.
        phoneNumber:
          type: string
          example: '85763644'
          description: Attendee's phone number.
        address1:
          type: string
          example: '85763644'
          description: Attendee's address, part one.
        address2:
          type: string
          example: '85763644'
          description: Attendee's address, part two.
        city:
          type: string
          example: '85763644'
          description: Attendee's city.
        state:
          type: string
          example: '85763644'
          description: Attendee's state.
        country:
          type: string
          example: '85763644'
          description: Attendee's country.
        zipCode:
          type: string
          example: '85763644'
          description: Attendee's zip code.
        registered:
          type: boolean
          description: Whether or not the attendee has registered the meeting.
        invited:
          type: boolean
          description: Whether or not the attendee has been invited to the meeting.
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps