Workflows

Get job status and telemetry

Retrieve the current status and telemetry information for a specific job

get/v4/workflows/{workflowId}/jobs/{jobId}

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows/{workflowId}/jobs/{jobId}
  • Auth: API key in header x-api-key

Path parameters

workflowIdstring required

The ID of the workflow

jobIdstring required

The ID of the job

Response

200

idstring required

The job ID

state'IN_PROGRESS' | 'FINISHED' | 'FAILED' | 'NOT_SUPPORTED' | 'FAILED_INSUFFICIENT_FUNDS' required

Current state of the job

startedAtstring date-time

Start date and time of the job

finishedAtstring date-time

Finish date and time of the job (if completed)

estimatedFinishedAtUtcstring date-time nullable

Estimated UTC finish time for an active workflow run

limitinteger nullable

Record limit for the job

workflowIdstring

ID of the workflow/scraper

variablesobject

Job variables

Changes

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