Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Tasks

Retrieve tasks

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: catalog(r).

Retrieve all tasks.

get/v1/tasks

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
num_results_per_pageinteger

The number of results per page to return.

Example:20
pageinteger

The page of results to return.

Example:1
offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

status'QUEUED' | 'IN_PROGRESS' | 'DONE' | 'FAILED' | 'CANCELED'
'ingestion' | 'user_data_request' | 'copy_data' | 'catalog_export'
OR
string[]
end_datestring

The end date to filter tasks by. Date format should be yyyy-mm-dd

Example:2024-12-31
start_datestring

The start date to filter tasks by. Date format should be yyyy-mm-dd

Example:2024-01-01
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Response

OK

total_countinteger required
status_countsobject required

Example response

{
  "tasks": [
    {
      "result": {
        "index_built": true,
        "ingestion_warnings": [
          {
            "code": "MISSING_FIELD",
            "message": "Field 'price' is missing for item 'product-123'",
            "data": {
              "item_id": "product-123",
              "field": "price"
            }
          }
        ]
      }
    }
  ]
}