---
title: "Get User Keyword Data Endpoint"
method: GET
path: "/api/v1/discoverspy/user-keywords"
tags: ["discoverspy"]
---

# Get User Keyword Data Endpoint

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

API to get user's default brand and their discover keywords data from discovery spy

## Response `200`

Successful Response

- UserKeywordResponse
  - `success` boolean, required
  - `message` string, required
  - `data` UserKeywordBrandData[], 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
    - `onboarding` boolean, required

---

[API](https://skmtc.dev/brandbooster/apis/fastapi.md) · [All operations](https://skmtc.dev/brandbooster/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/brandbooster/fastapi/revisions/624917d53409/schema)