Asynchronous File Export allows you to generate and download very large Timepiece report datasets as a single file without any timeout constraints. Unlike the synchronous export which must complete within the 60-second HTTP timeout window, async exports run as background processes on the server and you retrieve the file separately once it is ready. This makes async export the right choice for large Jira projects, busy instances, or any situation where you cannot predict how long the export will take.
The async export flow involves five endpoints, each handling a distinct part of the process.
Start an Export
POST /rest/export
This is the entry point. You call this endpoint with your full report configuration (filter type, report type, statuses, calendar, date ranges, output format, and any other parameters) exactly as you would for a synchronous export. The server validates the parameters, queues the export as a background job, and immediately returns a JSON response containing an exportId and a statusLink. The export begins processing in the background and the connection is closed.
See Start an Export for the full parameter reference and example requests.
Get Status of a Single Export
GET /rest/export/<export_id>
Use this endpoint to poll the progress of a specific export using the exportId returned when you started it. The response includes the export's current status, how many issues have been processed so far (completed), the total number of issues to be processed (total), and a downloadLink field that is populated once the export is complete.
See Get Status of a Single Export for the full reference and example response.
Get Status of All Exports
GET /rest/export
Returns a paginated list of all exports belonging to your user, both running and completed. Each entry in the list contains the same status fields as the single-export status endpoint, including the download link for completed exports. Useful for monitoring multiple concurrent exports or looking up the ID of a previously started export. Supports pageNumber and pageSize parameters, with a default page size of 100.
See Get Status of All Exports for the full reference and example response.
Download an Export File
GET /rest/export/<export_id>/download
Once the status of an export shows it is complete, call this endpoint with the exportId to download the generated file. The response is the file itself in the format you specified when starting the export (XLS, XLSX, CSV, or one of the CSV aggregation variants).
See Download an Export File for the full reference and example request.
Abort an Export
DELETE /rest/export/<export_id>
Sends a cancellation signal to a running export. If the export is still in progress when the signal is received, it will be stopped and its status will be set to Aborted. The response includes the export's final state, including how many issues were processed before it was stopped.
See Abort an Export for the full reference and example response.