SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Read a competitor public pages again and rebuild the gaps

Answers straight away with a task. When this competitor is already being read, the running task comes back with already_running true instead of a new one. 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

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

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

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/seo/competitors/{competitor_id}/crawl \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 202

{
"data": {
"task_id": "8a2f0c11-0000-4000-8000-000000000000",
"status": "received"
}
}