Skip to main content
POST
Launch an analysis

Headers

x-project-id
string
required

Project ID to specify the project context

Path Parameters

projectId
string<uuid>
required

Body

application/json
aiModels
string[]
required

Models that answer every selected query, by id or rolling alias

Example:
executionCount
number
required

How many times each query runs on each model

Required range: 1 <= x <= 100
Example:

3

selection
object

Absent: every query of the project

force
boolean

Launch even if a job started in the last 10 minutes

Example:

true

Response

id
string<uuid>
required

Id of the run, used to poll it and to list its executions

status
enum<string>
required

Run state: pending, processing, syncing (finished, results still reaching analytics), then completed, failed or partial_failed

Available options:
pending,
processing,
syncing,
completed,
failed,
partial_failed
totalExecutions
number
required

Executions the run holds: one per query, model and repeat

pendingExecutions
number
required

Executions still queued or in flight, with no answer yet

retryingExecutions
number
required

Executions that failed an attempt and are queued for another

successExecutions
number
required

Executions that came back with an answer

failedExecutions
number
required

Executions that gave up, their attempts spent

createdAt
string<date-time>
required

When the run was launched

updatedAt
string<date-time>
required

When a counter or the status last moved; a poller watches this

createdBy
object

Absent for a scheduled job or one launched with an API key