v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Basics

Get Competitors

Returns all competitors for a specific website.

get/api/v1/competitors

Query parameters

website_idstring uuid required

The ID of the website to retrieve competitors for

Response

Successful response with list of competitors

Example response

{
  "competitors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Competitor Inc",
      "url": "competitor.com",
      "normalized_url": "competitor.com",
      "identifiers": [
        "Competitor Inc",
        "competitor.com"
      ]
    }
  ]
}