DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsLogin with WebexGuest IssuerWidgetsWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationAccess the APIREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsUsing Webex Service AppsProvisioning APIsAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording Report
GETList of Recording Audit Report Summaries
GETGet Recording Audit Report Details
GETList Meeting Archive Summaries
GETGet Meeting Archive Details
RecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and Authorization
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsWebex for Wholesale
Reference
Call ControlsCall RoutingCalling Service SettingsDevice Call SettingsDevicesFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Receptionist ClientLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPeopleRecording Report
GETList of Recording Audit Report Summaries
GETGet Recording Audit Report Details
GETList Meeting Archive Summaries
GETGet Meeting Archive Details
ReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationWholesale and Broadworks Common GuideDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksUsing Webex Service AppsWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording Report
GETList of Recording Audit Report Summaries
GETGet Recording Audit Report Details
GETList Meeting Archive Summaries
GETGet Meeting Archive Details
RecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksUsing Webex Service AppsButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsDevice Call SettingsDevice ConfigurationsDevicesEventsFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Receptionist ClientGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording Report
GETList of Recording Audit Report Summaries
GETGet Recording Audit Report Details
GETList Meeting Archive Summaries
GETGet Meeting Archive Details
RecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

List of Recording Audit Report Summaries

Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return.

Only recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.

The list returned is sorted in descending order by the date and time that the recordings were created.

Long result sets are split into pages.

  • If siteUrl is specified, the recording audit report summaries of the specified site will be listed; otherwise, recording audit report summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the Get Site List API.
Request Header
  • timezone: Time zone in conformance with the IANA time zone database. The default is UTC if timezone is not defined.
GET/v1/recordingReport/accessSummary
Query Parameters
max
number

Maximum number of recording audit report summaries to return in a single page. max must be equal to or greater than 1 and equal to or less than 100.

Default: 10
from
string

Starting date and time (inclusive) for recording audit report summaries to return, in any ISO 8601 compliant format. from cannot be after to. Please note that the interval between to and from cannot exceed 90 days and the interval between the current time and from cannot exceed 365 days.

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.
to
string

Ending date and time (exclusive) for recording audit report summaries to return, in any ISO 8601 compliant format. to cannot be before from. Please note that the interval between to and from cannot exceed 90 days and the interval between the current time and from cannot exceed 365 days.

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.
hostEmail
string

Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user.

siteUrl
string

URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by Get Site List API.

Response Properties
items
array[RecordingReportSummaryObject]

An array of recording audit report summaries objects.

recordingId
string

A unique identifier for the recording.

topic
string

The recording's topic.

timeRecorded
string

The date and time the recording started in ISO 8601 compliant format. the time is the record button was clicked in the meeting.

siteUrl
string

Site URL for the recording.

hostEmail
string

Email address for the meeting host.

viewCount
number

The number of times the recording was viewed.

downloadCount
number

The number of times the recording was downloaded.

Response Codes

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

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
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.
  • Try it
  • Example
GET
/v1/recordingReport/accessSummary{?max,from,to,hostEmail,siteUrl}
Log in to try the API.
Header
Query Parameters
  • Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.
  • Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.
  • Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.
  • Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user.
  • URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.
  • Request
  • Response
https://webexapis.com/v1/recordingReport/accessSummary?from=2020-07-12T09:30:00+08:00&to=2020-07-31T09:30:00+08:00&hostEmail=john.andersen@example.com&siteUrl=example.webex.com
200 / OK
{
    "items": [
        {
            "recordingId": "4f914b1dfe3c4d11a61730f18c0f5387",
            "topic": "Example Topic",
            "timeRecorded": "2020-07-13T17:05:35Z",
            "siteUrl": "site4-example.webex.com",
            "hostEmail": "john.andersen@example.com",
            "viewCount": 18,
            "downloadCount": 10
           },
        {
            "recordingId": "3324fb76946249cfa07fc30b3ccbf580",
            "topic": "Example Topic",
            "timeRecorded": "2020-07-13T17:05:35Z",
            "siteUrl": "site4-example.webex.com",
            "hostEmail": "john.andersen@example.com",
            "viewCount": 0,
            "downloadCount": 2
        },
        {
            "recordingId": "42b80117a2a74dcf9863bf06264f8075",
            "topic": "Example Topic",
            "timeRecorded": "2020-07-13T17:05:35Z",
            "siteUrl": "site4-example.webex.com",
            "hostEmail": "john.andersen@example.com",
            "viewCount": 7,
            "downloadCount": 20
        }
    ]
}

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.