Read job progress

GET /jobs/. Required scopes: jobs:read.

GET /api/public/v1/jobs/{task_id}

Read job progress

cURL

curl --request GET \
  --url https://wisepim.com/api/public/v1/jobs/{task_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "task_id": "<string>",
  "task_type": "<string>",
  "status": "<string>",
  "stage": "<string>",
  "total_items": 123,
  "processed_items": 123,
  "successful_items": 123,
  "failed_items": 123,
  "skipped_items": 123,
  "progress_percentage": 123,
  "cancellation_requested": true,
  "started_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Path Parameters

task_id · string<uuid> · required

Response

200

application/json

OK

task_id · string · required

task_type · string · required

status · string · required

stage · string | null · required

total_items · integer · required

processed_items · integer · required

successful_items · integer · required

failed_items · integer · required

skipped_items · integer · required

progress_percentage · number · required

cancellation_requested · boolean · required

started_at · string<date-time> | null · required

updated_at · string<date-time> | null · required

finished_at · string<date-time> | null · required