campaign-reports

Get Report Generation Status

Changed on

Return the status of the newest report version (any status) and, while no run is in progress or ready, why the auto trigger will not start one.

get/v1/interviews/{interview_id}/report/generation-status

Request

Path parameters

interview_idstring uuid required

Headers

X-API-Keystring nullable

Response

Successful Response

status'in_progress' | 'ready' | 'failed'
error_code'report_requires_tagged_turns' nullable
blocked_reason'report_requires_tagged_turns' | 'below_floor'

Why the auto trigger will not start a report run.

completed_countinteger nullable
floor_countinteger nullable
version_numberinteger nullable
trigger_reason'threshold_reached' | 'incremental_update' | 'manual_regenerate' | 'campaign_completed'

What caused a campaign report version to be generated.

created_atstring date-time nullable
completed_atstring date-time nullable

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • warning

      added the new campaign_completed enum value to the / response property for the response status

    • info

      added the optional property to the response with the status