COcontext
Brand Intelligence

Brand Search

Changed on

Search indexed brands by name or domain

get/brand/search

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/brand/search
  • Auth
    HTTP bearer

Query parameters

querystring required

Search term, matched against the fields selected by queryBy (e.g. 'nike', 'nike.com', 'nik').

autocompleteboolean

Whether the search term matches by prefix, so partial words match as they are typed (e.g. 'nik' matches Nike). Set to false to match whole words only.

queryBystring[]

Fields to match the search term against, as a comma-separated list or repeated parameter: 'name', 'domain', or both. Defaults to both.

typoToleranceinteger

Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no typo tolerance).

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

Successful response

Example response

{
  "results": [
    {
      "domain": "nike.com",
      "name": "Nike",
      "logo": "https://logos.context.dev/?publicClientId=pub_1a2b3c&domain=nike.com"
    }
  ]
}

Changes

  • 24d2b91f5275Revision changes
    • info

      added the new optional query request parameter autocomplete

    • info

      added the new optional query request parameter queryBy

    • info

      added the new optional query request parameter typoTolerance

  • 00e371f8c2a5Revision changes
    • info

      endpoint added