Generate a Report and Poll for the Result

Generate a Report and Poll for the Result

Start an async report generation and poll by request id until it terminates.

1. Kick off the report generation. Ashby answers immediately with a requestId and a status, which is usually in_progress for any report large enough to justify this path over report.synchronous.
2. Poll the same operation with the requestId from the start step. Supplying requestId is what turns report.generate from a kickoff into a status check; omitting it would queue a second report instead of polling the first. The retry backs off
3. Take the finished report. This final call reads the completed generation by requestId and returns the rows and column names for the caller to load.

What you'll need to have ready

• reportId: The id of the report to generate.
• includeHeadersInData: When true (the default), column headers are included as the first row of the data array. When false, headers appear only in columnNames.

For your developer

Arazzo workflow ashby-hq:report-generate-poll, 3 operations: reportGenerate → reportGenerate → reportGenerate. Specs on APIs.io.