Read a competitor public pages again and rebuild the gaps.

Answers straight away with a task. Poll `GET /tasks/{task_id}` until it is completed, then read `GET /sites/{site_id}/competitors` for the refreshed gaps. Their robots.txt and crawl delay are obeyed, so a large site takes minutes.

POSThttps://app.softsolz.uk/api/v1/services/seo/competitors/{competitor_id}/crawl

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

competitor_idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

task_idstringPoll this.

statusstringWhere the task is.

Request

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

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

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

Credentials

Authorization

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

Response · 200

{
  "data": {
    "task_id": "string",
    "status": "string"
  }
}