post https://api.ashbyhq.com/report.generate
Generates a new report or polls the status of an existing report generation.
Two-step process:
- Call with only
reportId
to start generation → returnsrequestId
- Poll with both
reportId
andrequestId
every second untilstatus
iscompleted
orfailed
Example:
// Step 1: Start generation
POST /report.generate
{ "reportId": "abc-123-def-456" }
→ { "requestId": "req-789-xyz", "status": "in_progress", "reportData": null }
// Step 2: Poll for results
POST /report.generate
{ "reportId": "abc-123-def-456", "requestId": "req-789-xyz" }
→ { "requestId": "req-789-xyz", "status": "completed", "reportData": {...} }
For synchronous retrieval of existing data, use report.synchronous
.
Use this async endpoint for reports that may exceed 30 seconds.
Requires the reportsRead
permission.