Get Report Status (Reserved)

RESERVED: The keyword RESERVED annotation means that the API is available for use but is not yet part of the officially supported specification. Its behavior, interface, or output may change in future releases without backward compatibility guarantees.

Overview

Returns the status of report generation jobs for the specified application. When id is omitted, a list of all jobs is returned. When id is provided, the status of that specific job is returned.

URI

GET /rest/applications/{application}/reports/status

Path parameters

application (string) — Application name.

Query parameters

Parameter	Type	Required	Default	Description
id	string	No	—	ID of a specific report job. When omitted, all jobs are returned.

Responses

application/json

When `id` is omitted — all jobs (200 OK)

{
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Done",
      "reportName": "Transactions Complexity",
      "appName": "my-application",
      "fileType": "csv",
      "createdAt": 1718000000,
      "username": "john.doe"
    }
  ]
}

JSON representation

Property	Type	Description
results	array	List of report jobs.
results[].id	string	Unique identifier of the report job.
results[].status	string	Current status of the job. Possible values: `Running`, `Done`, `Failed`.
results[].reportName	string	Name of the report.
results[].appName	string	Name of the application the report was generated for.
results[].fileType	string	Output format of the report (`csv`, `xlsx`, or `json`).
results[].createdAt	integer	Unix timestamp (seconds) of when the job was created.
results[].username	string	User who requested the report.
results[].error	string	Error message if the job failed. Omitted when the job succeeded.

When `id` is provided — single job (200 OK)

Returns the current status of the specified job. The response shape varies depending on the job state.