v1

latestOpenAPI 3.0.02026-07-222980136.7 KB

Brand Reports

Get a brand report

get/v1/reports/brand/{reportId}

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Brand report identifier.

Response

The brand report.

idstring required

workspaceIdstring required

brandstring required

reportTitlestring

brandVariationsstring[]

brandDomainstring required

brandDomainVariationsstring[]

brandDomainWildcardboolean

countriesstring[] required

Lowercase ISO 3166-1 alpha-2 country codes the report tracks (e.g. us, de), with uk used in place of gb.

createdDatestring required

updatedDatestring required

promptIdsstring[]

countryPromptsTotalobject

Total prompt count keyed by country code (lowercase ISO 3166-1 alpha-2; uk instead of gb).

Example response

{
  "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",
  "promptIds": [
    "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
    "01HXP2DRTM5G8Z2N3KQ7VAW4PB"
  ],
  "countryPromptsTotal": {
    "us": 50,
    "de": 35,
    "uk": 28
  },
  "tags": [
    {
      "id": "01HX8AB3CDE4FG5HJ6KL7MN8PQ",
      "name": "Running Shoes",
      "color": "orange"
    }
  ]
}