internal

List Runs

get/internal/evals/requirement-applicability/runs

Query parameters

company_idstring uuid nullable
limitinteger

Response

Successful Response

applicability_run_idstring uuid required
company_idstring uuid required
company_namestring nullable required
file_idstring uuid required
upload_idstring uuid required
collateral_filenamestring nullable required
collateral_type'Agent Call Flow' | 'Audio' | 'Billboard' | 'Communications' | 'Conversation Design' | 'Email' | 'Help Center Article' | 'In-App' | 'Mailer' | 'Organic Social' | 'Paid Advertising' | 'Paid Search' | 'Paid Social' | 'Press Release' | 'Procedure/Decision Tree' | 'Support Agent Training' | 'TV' | 'Web' | 'Wiki' | 'Other' required
status'queued' | 'running' | 'succeeded' | 'failed' required

Lifecycle of one dashboard run. Mirrors DecompositionStatus deliberately.

stage'queued' | 'downloading' | 'narrowing' | 'evaluating' | 'comparing' | 'done' required

What the run is doing right now.

Committed before the work it names starts, so a watcher sees the stage currently taking the time rather than the last one that finished.

errorstring nullable required
createdstring date-time required
started_atstring date-time nullable required
finished_atstring date-time nullable required
requested_by_emailstring nullable required
candidates_totalinteger required
candidates_survivinginteger required
risks_producedinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.