Competitor Tracker & Co. Docs
Competitors

Get a single competitor subscription belonging to the current organization.

Get a single competitor subscription belonging to the current organization — Competitor Tracker & Co. API reference for GET /v1/competitors/{id}: request.

Required role: member or higher (organization-level).

Required scope: competitors:read (for both OAuth2 tokens and API keys).

GET
/v1/competitors/{id}

Authorization

X-API-Key<token>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://api.competitortracker.io/v1/competitors/01HF..."
{
  "id": "string",
  "url": "string",
  "normalizedUrl": "string",
  "name": "string",
  "description": "string",
  "displayName": "string",
  "faviconUrl": "string",
  "competitorKind": "company",
  "parentCompetitorId": "string",
  "children": [
    {
      "id": "string",
      "url": "string",
      "normalizedUrl": "string",
      "name": "string",
      "competitorKind": "company"
    }
  ],
  "trackedCategories": [
    "string"
  ],
  "labels": [
    {
      "id": "string",
      "name": "string",
      "color": "string"
    }
  ],
  "addedAt": "string",
  "paused": true,
  "pauseReason": "string",
  "nextChargeAt": "string",
  "billing": {
    "costPerCycle": 0,
    "isOwnApp": true,
    "coinsPaidUntil": "string"
  },
  "crawlHealth": "permanent_dead",
  "healthDetail": "string",
  "lastCrawledAt": "string",
  "updatedAt": "string"
}
{
  "code": "string",
  "message": "string",
  "resolution": "string"
}

Subscribe the current organization to a competitor by URL. POST

Subscribe the current organization to a competitor by URL — Competitor Tracker & Co. API reference for POST /v1/competitors: request parameters, request body.

Update per-org config (display name, tracked categories) for a subscription. PATCH

Update per-org config (display name, tracked categories) for a subscription — Competitor Tracker & Co. API reference for PATCH /v1/competitors/{id}: request.