Skip to main content
GET
Get Report Generation Status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

interview_id
string<uuid>
required

Response

Successful Response

Latest version regardless of readiness — lets the report page tell generating / failed / ready apart without downloading artifacts.

Deliberately no error_message: version errors are raw worker tracebacks, which never belong in a user-facing surface. error_code names the known, user-actionable failures so the UI can show its own copy.

blocked_reason says why no run will start on its own while none is in progress or ready — the same rule the automatic trigger applies, so the page never claims a report is being prepared when nothing is queued. completed_count and floor_count are the counts that rule compared.

status
enum<string> | null
Available options:
in_progress,
ready,
failed
error_code
string | null
Allowed value: "report_requires_tagged_turns"
blocked_reason
enum<string> | null

Why the auto trigger will not start a report run.

Available options:
report_requires_tagged_turns,
below_floor
completed_count
integer | null
floor_count
integer | null
version_number
integer | null
trigger_reason
enum<string> | null

What caused a campaign report version to be generated.

Available options:
threshold_reached,
incremental_update,
manual_regenerate,
campaign_completed
created_at
string<date-time> | null
completed_at
string<date-time> | null