Crawl the website to map internal links.

Queues a crawl within the plan page budget. Poll GET /sites/{site_id}/crawls until status is completed, then read GET /sites/{site_id}/internal-links. 409 crawl_in_progress means one is already running.

POSThttps://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.

Idempotency-Keystring

Optional idempotency key for safe retries.

Response

Response Body

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.startCrawl('<site_id>', {});
console.log(result);

Credentials

Authorization

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

Response · 202

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