List recent crawls of the website.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/crawls

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

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

Query Params

limitinteger

Page size, 1 to 200 (default 50).

offsetinteger

Rows to skip before the first result.

Response

Response Body · array of objects

idstringCrawl id. Use it as crawl_id.

statusstringqueued, running, completed, failed or cancelled.

pages_budgetintegerPages the crawl may read.

pages_crawledintegerPages read so far.

links_foundintegerLinks recorded so far.

broken_countintegerBroken internal links found.

truncatedbooleanThe site had more pages than the budget.

error_messagestring | nullWhy the crawl failed, when it did.

started_atstring | nullWhen crawling began.

finished_atstring | nullWhen it ended.

created_atstringWhen it was requested.

Request

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

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

const result = await client.seo.listSiteCrawls('<site_id>', {});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": [
    {
      "id": "string",
      "status": "string",
      "pages_budget": 0,
      "pages_crawled": 0,
      "links_found": 0,
      "broken_count": 0,
      "truncated": true,
      "error_message": "string",
      "started_at": "string",
      "finished_at": "string",
      "created_at": "string"
    }
  ]
}