Skip to main content
GET
/
brands
/
{brand_id}
/
competitors
List Competitors
curl --request GET \
  --url https://api.scrunchai.com/v1/brands/{brand_id}/competitors \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "alternative_names": [],
      "websites": []
    }
  ],
  "offset": 0,
  "limit": 123,
  "metadata": {
    "aggregation_granularity": "daily",
    "period_count": 123,
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "top_domains": {
      "domains": [
        {
          "domain": "<string>",
          "domain_owner": "<string>",
          "observation_count": 123
        }
      ],
      "grand_total": 123,
      "owner_totals": {},
      "owner_time_series": [
        {
          "time_bucket": "<string>",
          "brand": 123,
          "competitor": 123,
          "other": 123
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

Query Parameters

limit
integer
default:100
Required range: x >= 1
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

total
integer
required
items
APICompetitorListing · object[]
required
offset
integer
default:0
limit
integer | null
metadata
TimeSeriesMetadata · object