Tasking API

Get Pipeline Status

Needed Permissions: No permissions are required to access this API endpoint.

POST /tasking/get-status
Request JSON Object:
  • pipelineId (string) – required;

  • getProgress (bool) – optional; whether to retrieve progress of the pipeline

Example request:

    "pipelineId": "3g4PovfhGxmymQolpgvv"

Example request:

    "pipelineId": "3g4PovfhGxmymQolpgvv",
    "getProgress": true
Response JSON Object:
  • status (string) – status of the pipeline

  • nextTry (int) – recommended delay for next status check in seconds. Available only when pipeline status is NEW or PROCESSING.

  • progress (dict) – progress stage of the pipeline. Only reported for pipelines with PROCESSING status and if getProgress parameter is set to true.

  • progress.message (string) – progress message

  • progress.provider (string) – name of the provider. Optional.

  • progress.step (int) – step of the pipeline. Total number of steps is 6.

Example response:

    "status": "RESOLVED"

Example response:

    "nextTry": 14,
    "status": "PROCESSING",
    "progress": {
        "message": "Downloading data from provider",
        "provider": "Planet",
        "step": 3

List of pipeline statuses:

  • NEW - a pipeline is not yet been processed.

  • PROCESSING - a pipeline is being processed.

  • FAILED - an error occurred during pipeline processing.

  • RESOLVED - a successfully resolved pipeline.

List of possible progress values:

  • Unknown - returned when no tasks associated with the pipeline were found

  • Preparing analysis

  • Ordering data from provider

  • Waiting for provider data to become available

  • Downloading data from provider

  • Analyzing

  • Finalizing analysis