Partner Reports - List Reports | Webex for Developers

List Reports

Lists all reports previously generated from a given region. Use query parameters to filter the response. The parameters are optional.

To access this endpoint, you must use an administrator token with spark-admin:reports_read and identity:people_read scopes.

CSV reports for Teams services are only supported for organizations based in one region per API request. Organizations based in a different region will require a separate request with region specified.

When no region is specified, the request defaults to Partner organization's home region.

Reports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.

GET/v1/partner/reports

Query Parameters

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.

string

List reports that were created before this date.

regionId

string

Data in the report will be from organizations in this region, for example, US, CA, or EU.

Response Properties

Report Attributes

array[Report]

An array of report objects.

reportId

string

Unique identifier for the report.

templateId

number

Unique ID representing valid report templates.

title

string

Name of the template to which this report belongs.

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.

regionId

string

The data in the report is from organizations in this region.

createdTime

string

Time of creation for this report in UTC time.

status

string

Completion status of this report.

fileName

string

The CSV filename of this report.

fileSize

number

The file size of this report.

checksum

string

The checksum for this report file.

downloadURL

string

The link from which the report can be downloaded.

downloadUrlExpiryTime

string

The time after which the download link becomes invalid.

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.

GET

/v1/partner/reports{?service,templateId,from,to,regionId}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

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.
regionId
string
Data in the report will be from organizations in this region, for example, US, CA, or EU.

https://webexapis.com/v1/partner/reports?service=Webex&templateId=5&from=2024-05-01&to=2024-05-05&regionId=US

200 / OK

[
    {
        "reportId" : "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
        "templateId": 5,
        "title": "Calling Usage Reports",
        "service" : "Teams",
        "startDate" : "2024-03-17",
        "endDate" : "2024-03-18",
        "regionId": "US"
        "createdTime" : "2024-05-27 17:02:43",
        "status": "done",
        "fileName": "Calling Usage_12345_Org_2024-05-01_2024-05-05.csv",
        "fileSize": 1024,
        "checksum": "575da04",
        "downloadURL": "https://downloadservicebts.webex.com/api?reportId=Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg",
        "downloadUrlExpiryTime": "3600"
    }
]