v1

latestOpenAPI 3.0.02026-07-222980136.7 KB

Brand Reports

List brand reports

get/v1/reports/brand

Query parameters

cursorstring

Optional. Pagination cursor — pass back the nextCursor value from a previous response. Omit to fetch the first page.

workspaceIdstring

Optional. Filter results to a specific workspace the API key has access to. If omitted, results span every workspace the API key can read.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Optional. Filter results to a specific workspace the API key has access to. If omitted, results span every workspace the API key can read.

Response

A list of brand reports.

Example response

{
  "items": [
    {
      "id": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
      "workspaceId": "01HX7K2YV9D3M8N0G6Q5R4S3T2",
      "brand": "Adidas",
      "brandVariations": [
        "adidas",
        "Adidas AG"
      ],
      "brandDomain": "adidas.com",
      "brandDomainVariations": [
        "adidas.de",
        "adidas.co.uk"
      ],
      "brandDomainWildcard": false,
      "countries": [
        "us",
        "de",
        "uk"
      ],
      "competitors": [
        {
          "brand": "Nike",
          "brandVariations": [
            "nike",
            "Nike Inc."
          ],
          "brandDomain": "nike.com",
          "brandDomainVariations": [
            "nike.de",
            "nike.co.uk"
          ],
          "brandDomainWildcard": false
        }
      ],
      "reportTitle": "Adidas Visibility Report",
      "createdDate": "2024-11-01T12:00:00.000Z",
      "updatedDate": "2025-05-01T08:30:00.000Z"
    }
  ],
  "paging": {
    "nextCursor": null,
    "hasMore": false
  }
}