---
title: "Get User Competitor Data"
method: GET
path: "/api/v1/discoverspy/user-competitor"
tags: ["discoverspy"]
---

# Get User Competitor Data

`GET /api/v1/discoverspy/user-competitor`

## Request

- Base URL: `https://api.brandbooster.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.brandbooster.ai/api/v1/discoverspy/user-competitor`
- Auth: HTTP bearer

API to get user's default brands, their discover keywords and competitors,
and their total ads and image counts from discovery spy

## Response `200`

Successful Response

- UserCompetitorResponse
  - `success` boolean, required
  - `message` string, required
  - `data` UserCompetitorBrandData[], required
    - `default_brand` DefaultBrand, required
      - `name` string, required
      - `logo` string, nullable
    - `keyword_data` KeywordData[], required
      - `keyword` string, required
      - `total_images` integer
      - `total_videos` integer
      - `active_ads` integer
      - `inactive_ads` integer
      - `keywordSpy_added` boolean
    - `competitors` CompetitorData[], required
      - `brand_name` string, required
      - `avatar_url` string, nullable
      - `total_images` integer
      - `total_videos` integer
      - `active_ads` integer
      - `inactive_ads` integer
      - `brandSpy_added` boolean
      - `adlibrary_url` string, nullable
    - `onboarding` boolean, required

---

[API](https://skmtc.dev/brandbooster/apis/brandbooster-api.md) - [All operations](https://skmtc.dev/brandbooster/apis/brandbooster-api/llms.txt) - [OpenAPI document](https://skmtc.dev/brandbooster/apis/brandbooster-api/revisions/02d28bde684c?raw)