Poll a background task.

Poll every few seconds until status is completed, failed or cancelled.

GEThttps://app.softsolz.uk/api/v1/services/seo/tasks/{task_id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

task_idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

idstringBackground task id.

kindstringseo.analysis.run, seo.metrics.sync, seo.links.verify or seo.crawl.run.

statusstringPoll until completed, failed or cancelled.

progressobjectCounters maintained while the task runs.

errorstring | nullWhy the task failed, when it did.

created_atstringWhen it was queued.

started_atstring | nullWhen a worker picked it up.

completed_atstring | nullWhen it reached a terminal state.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.getTask('<task_id>');
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": "string",
    "kind": "string",
    "status": "string",
    "progress": {},
    "error": "string",
    "created_at": "string",
    "started_at": "string",
    "completed_at": "string"
  }
}