---
title: "Get a brand report"
method: GET
path: "/v1/reports/brand/{reportId}"
tags: ["Brand Reports"]
---

# Get a brand report

`GET /v1/reports/brand/{reportId}`

## Request

- Base URL: `https://data.otterly.ai`
- URL: `https://data.otterly.ai/v1/reports/brand/{reportId}`
- Auth: HTTP bearer

## Path parameters

- `reportId` string, required: Brand report identifier.

## Response `200`

The brand report.

- PublicApiBrandReport
  - `id` string, required
  - `workspaceId` string, required
  - `brand` string, required
  - `reportTitle` string
  - `brandVariations` string[]
  - `brandDomain` string, required
  - `brandDomainVariations` string[]
  - `brandDomainWildcard` boolean
  - `brandRegex` string, nullable, required: Regular expression used to detect the brand in AI answers, instead of `brand` and `brandVariations`. `null` when not set.
  - `countries` string[], required: Lowercase ISO 3166-1 alpha-2 country codes the report tracks (e.g. `us`, `de`), with `uk` used in place of `gb`.
  - `createdDate` string, required
  - `updatedDate` string, required
  - `promptIds` string[]
  - `countryPromptsTotal` object: Total prompt count keyed by country code (lowercase ISO 3166-1 alpha-2; `uk` instead of `gb`).
  - `competitors` PublicApiBrandCompetitor[]
    - `brand` string, required: Competitor brand name.
    - `brandVariations` string[], required
    - `brandDomain` string, required
    - `brandDomainVariations` string[], required
    - `brandDomainWildcard` boolean, required
    - `brandRegex` string, nullable, required: Regular expression used to detect the brand in AI answers, instead of `brand` and `brandVariations`. `null` when not set.
  - `tags` PublicApiBrandReportTag[]
    - `id` string, required
    - `name` string, required
    - `color` string, required: Tag color (Ant Design preset color name, e.g. 'gold', 'orange', 'magenta', 'green', 'blue').

## Other responses

- `400`: Validation failed.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Report not found.

## Changes

- **2026-11-03** `b5dc4bea6d45`: 2 info
  - added the required property `brandRegex` to the response with the `200` status
  - added the required property `competitors/items/brandRegex` to the response with the `200` status

[Operation history](https://skmtc.dev/otterly/apis/otterly-public-api/changes/v1/reports/brand/:reportId/get.md)

---

[API](https://skmtc.dev/otterly/apis/otterly-public-api.md) - [All operations](https://skmtc.dev/otterly/apis/otterly-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/otterly/apis/otterly-public-api/revisions/333e3100f0b4?raw)