Add a competitor to compare against
Adding one starts reading their site straight away, and reading is true while that runs. Read the gaps back from GET /sites/{site_id}/competitors once reading is false. Their robots.txt is respected and a site that asks not to be read is refused. 409 competitor_exists means that domain is already on the list for this website.
POST
https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/competitorsRecent Requests
Kept only in this browserTimeStatusTook
Send a request with Try it to see it here.
Path Params
site_idstringrequiredHeaders
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Body Params
domainstringrequiredTheir domain, with or without the scheme.
labelstring | nullWhat you call them.
crawl_budgetinteger | nullHow many of their pages to read at most, 1 to 2000.
Response
Response Body
idstringThe competitor id.domainstringTheir domain.labelstring | nullWhat you call them.statusstringactive, paused or removed.crawl_budgetintegerHow many of their pages will be read at most.robots_allowsboolean | nullWhether their robots.txt lets us read the site. Null until first read.pages_crawledintegerPages read last time.last_crawled_atstring | nullWhen they were last read.last_errorstring | nullWhy the last read did not finish, when it did not.readingbooleanTrue while their site is being read. Sent when listing competitors and when adding one.Request
curl --request POST \ --url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/competitors \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "domain": "rival.com", "label": "Closest rival", "crawl_budget": 200}'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 · 201
{ "data": { "id": "5f1d0a3e-0000-4000-8000-000000000000", "domain": "rival.com", "label": "Closest rival", "status": "active", "crawl_budget": 200, "robots_allows": true, "pages_crawled": 184, "last_crawled_at": "2026-09-20T02:00:00Z", "last_error": null, "reading": false }}