SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

The competitors set up for a website, and the topic gaps between their pages and yours

Gaps are only produced once a competitor has been read at least once and your own topics exist, so call POST /sites/{site_id}/competitors/{competitor_id}/crawl first if crawled is false. Topics come from your own Search Console queries, so a gap always sits on a topic you already have demand for.

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

Recent Requests

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

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

competitorsarray of objectsSet up for this website.
gapsarray of objectsLargest first.
crawledbooleanWhether any competitor has been read yet.
measurablebooleanFalse when gaps cannot be computed yet. Read reason to find out what is missing.
reasonstring | nullneeds_crawl when your own website has not been crawled, no_topics when your search data has not been clustered yet, pages_not_matched when your topics were rebuilt but your pages have not been matched to them yet (so a missing page cannot be told apart from an unmatched one), null when gaps were computed.
revisioninteger | nullWhich build of your topics the gaps were computed against.
notestringWhat this data is and is not.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/competitors \
--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 · 200

{
"data": {
"competitors": [
{
"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
}
],
"gaps": [
{
"kind": "competitor_topic_gap",
"topic_id": 412,
"topic": "payroll software",
"competitor_domain": "rival.com",
"competitor_best_url": "https://rival.com/payroll",
"competitor_pages": 3,
"competitor_words": 2100,
"our_url": "https://example.com/payroll",
"our_words": 700,
"missing_schema": [
"FAQPage"
],
"evidence": "They publish on this topic and you have no page for it."
}
],
"crawled": true,
"measurable": true,
"reason": null,
"revision": 7,
"note": "Everything here comes from a public page of theirs. Nothing here is their traffic or their ranking, and neither can be known."
}
}