List Reports

Lists all reports. Use query parameters to filter the response. The parameters are optional. However, 'from' and 'to' parameters should be provided together.

CSV reports for Teams services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.

GET/v1/reports
Query Parameters
reportId
string

List reports by ID.

service
string

List reports which use this service.

templateId
number

List reports with this report template ID.

from
string

List reports that were created on or after this date.

to
string

List reports that were created before this date.

Response Properties
Report Attributes
array

An array of report objects.

id
string

Unique identifier for the report.

title
string

Name of the template that this report belongs to

service
string

The service to which the report belongs

startDate
string

The data in this report belongs to dates greater than or equal to this

endDate
string

The data in this report belongs to dates smaller than or equal to this

siteList
string

The site to which this report belongs to. This only exists if the report belongs to service 'Webex'

created
string

Time of creation for this report

createdBy
string

The person who created the report.

scheduledFrom
string

Whether this report was scheduled from API or Control Hub

status
string

Completion status of this report

downloadURL
string

The link from which the report can be 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.
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/reports{?reportId,service,templateId,from,to}
Log in to try the API.
Header
Query Parameters
  • List reports by ID.
  • List reports which use this service.
  • List reports with this report template ID.
  • List reports that were created on or after this date.
  • List reports that were created before this date.
https://webexapis.com/v1/reports?reportId=Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE&service=Webex&templateId=5&from=2020-05-01&to=2020-05-05
200 / OK
{
    "items" :
        [
            {
                "id" : "Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg",
                "service" : "Teams",
                "startDate" : "2020-03-17",
                "endDate" : "2020-03-18",
                "siteList" : "",
                "created" : "2020-05-27 17:02:43",
                "createdBy" : "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
                "scheduleFrom" : "api",
                "status" : "done",
                "reportTitle" : "Bots Activity",
                "downloadURL": "https://downloadservicebts.webex.com/api?reportId=Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg"
            }
        ],
    "numberOfReports" : 1
}