Sign in
latestOpenAPI 3.0.42026-08-213579001013.0 KB

5f993bd211f5

Job

Gets a job by its id.

get/job/{jobId}

Path parameters

jobIdstring required

The id of the job to retrieve.

Response

OK

jobIdstring required

The job id.

namestring required

The job name.

definitionIdstring required

The job definition id.

audienceIdstring required

The audience id.

revisionNumberinteger required

The revision number.

pipelineIdstring required

The pipeline id.

campaignIdstring nullable

The job's campaign id. Null when the pipeline did not yield exactly one campaign.

audienceNamestring nullable

The audience name, or null when the job's audience has since been deleted (jobs outlive their audience).

state'Submitted' | 'Running' | 'Completed' | 'Failed' | 'ManualApproval' | 'Queued' | 'Paused' | 'StaleResults' | 'SpendLimited' required
isPublicboolean required

Whether the job (and its results) is shared publicly.

audienceDeletedboolean required

Whether the audience backing this job was deleted, meaning the job can never run.

completedAtstring date-time nullable

The timestamp when the job was completed.

resultFileNamestring nullable

The file name of the result.

failedAtstring date-time nullable

The timestamp when the job failed.

failureMessagestring nullable

The failure message.

reviewReason'ContentFlagged' | 'UnsupportedContentType' | 'CheckErrored' | 'ClassificationTimedOut' | 'null' nullable

Why the job was routed to manual review, when it is (or was) in ManualApproval. Null when no customer-facing reason applies.

createdAtstring date-time required

The creation timestamp.

ownerIdstring uuid required

The owner id.

ownerMailstring required

The owner email.

organizationIdstring required

The id of the organization that owns the entity.