SPsponsorunited
Brand Competitors

List a brand's competitors

Paginated list of a brand's visible competitors, linked and unlinked. Rows removed by an admin or no longer returned by the scrape are left out. Requires approve-company permission.

get/api/admin/brand-competitors

Request

Query parameters

source_brand_idinteger required
Example:4711

The brand (companies.id) whose competitors are listed.

qstring
Example:pep

Substring search over the competitor name and the linked SponsorUnited brand name.

decision_source'auto_linked' | 'approved' | 'admin_added' | 'unlinked'

Only rows in this category.

order_by'raw_name' | 'created_at' | 'last_seen_at'

Sort column. Default: raw_name.

order_direction'asc' | 'desc'

Sort direction. Default: asc.

pageinteger
per_pageinteger

Response

Paginated competitors.

current_pageinteger
first_page_urlstring nullable
frominteger nullable
last_pageinteger
last_page_urlstring nullable
next_page_urlstring nullable
pathstring nullable
per_pageinteger
prev_page_urlstring nullable
tointeger nullable
totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 81,
      "source_brand_id": 4711,
      "raw_name": "Pepsi Inc.",
      "normalized_name": "pepsi",
      "linked": true,
      "target_brand": {
        "id": 9001,
        "name": "Pepsi"
      },
      "decision_source": "auto_linked",
      "origin": "scraped",
      "decision": "auto_linked",
      "match_source": "meilisearch",
      "score_at_decision": 97,
      "decided_by": {
        "id": 42,
        "name": "Jane Reviewer",
        "email": "jane@sponsorunited.com"
      }
    }
  ],
  "from": 1,
  "last_page": 2,
  "per_page": 25,
  "to": 25,
  "total": 31
}

Changes

No recorded changes to this operation across all 2 revisions of this API.