Start a report export
Queue (or return) the export for this report. Idempotent per (report, format).
202 while the worker still owes a file, 200 with a signed URL once it is cached. body.format
is a Literal["docx"], so an unknown format is a 422 from validation and never reaches the
enum cast in SQL.
Authorization
OrgApiKey AuthorizationBearer <token>
Organization API key. Send as Authorization: Bearer <key>. Create one in Admin > Settings > API keys.
In: header
Path Parameters
report_id*Report Id
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://api.auditmark.io/v1/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/exports" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971", "format": "string", "status": "string", "generated_at": "2019-08-24T14:15:22Z", "signed_url": "string", "status_reason": "export_failed"}{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971", "format": "string", "status": "string", "generated_at": "2019-08-24T14:15:22Z", "signed_url": "string", "status_reason": "export_failed"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string", "input": null, "ctx": {} } ]}