Generate a report export

Schedule generation of an export (JSON, PDF or Excel) for a single report.

Export generation is asynchronous: this endpoint enqueues the work and
immediately returns a generation_id. Poll
GET /external/export/status?generation_id={generation_id} until the response
reports is_finished: true; the finished payload then carries the JSON export
data (for JSON exports) or a pre-signed download URL (for PDF / Excel exports).

Choosing which export to run

  • Omit both export_id and export_name to run your default report export.
  • Provide export_id to run a specific export by its identifier, or
    export_name to run it by name. Provide at most one of the two; sending
    both returns 400.

The output format is determined by the export's own definition.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

The ID of the report to export.

Query Params
uuid

Run a specific export, identified by its ID. Mutually exclusive with export_name. When neither is provided, the default report export is used.

string

Run a specific export, identified by its name. Mutually exclusive with export_id. When neither is provided, the default report export is used.

Responses

400

The request is invalid — for example both export_id and export_name were provided.

401

The bearer token is missing or invalid.

404

The report was not found, or the requested export was not found or is not published.

422

Validation Error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json