Get Report (Reserved)

Overview

Downloads a generated report file or lists available reports for an application. When report_id and/or report_name is provided, the report file is returned as a downloadable attachment. When both are omitted, the response contains the list of reports available for the application.

When both report_id and report_name are provided, they must refer to the same report, or the request is rejected with a 400 error.

URI

GET /rest/applications/{application}/reports

Path parameters

  • application (string) — Application name.

Query parameters

Parameter Type Required Default Description
report_id integer No — Identifier of the report to download. See the Generate Report Report IDs table. When omitted along with report_name, returns the list of available reports.
report_name string No — Name of the report to download (case-insensitive). When omitted along with report_id, returns the list of available reports.
file_type string No csv Format of the report to download. Accepted values: csv, xlsx, json.
date string No — Snapshot date for the report data.

Responses

When report_id and/or report_name is provided — file download (200 OK)

The report file is returned as a binary attachment.

File Type Content-Type
csv text/csv
xlsx application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
json application/json

The response includes a Content-Disposition: attachment; filename="report.<file_type>" header.

When both are omitted — list of available reports (200 OK)

application/json

Returns the list of reports available for the application.

Error Response (400 Bad Request)

Returned when:

  • report_name does not match any known report, or
  • report_id and report_name are both provided but refer to different reports.