PEpeec
Products

List Global Brands

Changed on

Search Peec's global brand catalog — the shared registry of real-world brands that products attach to via global_brand_id. Use it to find the global_brand_id for a brand when creating products. This is separate from GET /brands, which lists the brands a project tracks for AI-visibility reporting; the two use different ids. Primarily used with search. Pass ownership (own, competitor, or all) instead to list the project's shopping brands ranked by mentions, for use as shopping brand filters.

get/global-brands

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/global-brands
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb
searchstring

Search the catalog by brand name (matches names and aliases). The primary way to use this endpoint.

Example:nike
ownership'own' | 'competitor' | 'all'

List the project's shopping brands instead of searching the catalog, ranked by all-time shopping mention count: own for the project's own brands, competitor for competitors appearing in shopping data, all for both.

limitinteger
offsetinteger

Response

Success

total_countnumber required

Total number of matching brands, ignoring pagination

totalCountnumber required

Total number of matching brands, ignoring pagination

Example response

{
  "data": [
    {
      "id": "019ecb6e-d030-7222-b531-b371fe9db583",
      "name": "Nike",
      "domain": "nike.com",
      "description": "American athletic footwear and apparel company"
    }
  ],
  "total_count": 42,
  "totalCount": 42
}

Changes

  • 9fdffdff48a5Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

      for the query request parameter offset, the type changed from number to integer

    • warning

      for the query request parameter offset, the max was set to 9007199254740991.00