SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

List background SEO tasks.

List background SEO tasks.

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

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Headers

Authorizationstringrequired

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

Query Params

statusstring

Filter by task status.

limitinteger

Page size, 1 to 200 (default 50).

offsetinteger

Rows to skip before the first result.

Response

Response Body · array of objects

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.listTasks({});
console.log(result);

Credentials

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"
}
]
}