SurfacedBySurfacedBy Docs
DocumentationAPIReference

Competitors

Read the confirmed competitors for a tracked domain.

Ask an AI:Open in ChatGPTOpen in Claude

The competitors endpoints return a domain's confirmed competitors: the same list the dashboard's Competitors page uses. Competitors that are still unreviewed, that were dismissed, or that the dashboard hides are not returned. The single-competitor endpoint returns one row from that list, and a competitor outside the list returns 404 not_found. A domain the key cannot read returns 404 domain_not_found.

Both endpoints are read-only and available on Professional and Agency. Confirming, dismissing, or adding competitors is done in the dashboard.

Competitor object

FieldDescription
idCompetitor id, used as competitor_id.
domain_idThe tracked domain this competitor belongs to.
competitor_domainThe competitor's domain.
display_nameThe name the competitor's own site declares, or null. It is never guessed from the domain.
discovery_sourceadded_by_you when someone in your workspace entered the competitor (in the dashboard or during setup), detected when SurfacedBy found it in AI answers.
user_confirmedWhether the competitor is confirmed. Always true in these responses.
discovered_atWhen the competitor was first found.
last_updatedWhen the competitor record last changed. The list is sorted by this field, newest first.
GET
/domains/{domain_id}/competitors
/domains/{domain_id}/competitors

Path Parameters

domain_id
Required
Domain Id

Query Parameters

cursorCursor

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://api.surfacedby.com/api/v1/ext/domains/string/competitors?cursor=string" \
  -H "X-API-Key: string"

Successful Response

null

GET
/domains/{domain_id}/competitors/{competitor_id}
/domains/{domain_id}/competitors/{competitor_id}

Path Parameters

domain_id
Required
Domain Id

competitor_id
Required
Competitor Id

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://api.surfacedby.com/api/v1/ext/domains/string/competitors/string" \
  -H "X-API-Key: string"

Successful Response

null

On this page