---
title: "List brand reports"
method: GET
path: "/v1/reports/brand"
tags: ["Brand Reports"]
---

# List brand reports

`GET /v1/reports/brand`

## Query parameters

- `cursor` string — Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page.
- `workspaceId` string — 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 `200`

A list of brand reports.

- PublicApiBrandReportsList
  - `items` PublicApiBrandReportListItem[], required
    - `id` string, required
    - `workspaceId` string, required
    - `brand` string, required
    - `brandVariations` string[]
    - `brandDomain` string, required
    - `brandDomainVariations` string[]
    - `brandDomainWildcard` boolean
    - `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`.
    - `competitors` PublicApiBrandCompetitor[]
      - `brand` string, required — Competitor brand name.
      - `brandVariations` string[], required
      - `brandDomain` string, required
      - `brandDomainVariations` string[], required
      - `brandDomainWildcard` boolean, required
    - `reportTitle` string
    - `createdDate` string, required
    - `updatedDate` string, required
  - `paging` PublicApiCursorPageInfo, required
    - `nextCursor` string, nullable, required
    - `hasMore` boolean, required

## Other responses

- `400` — Validation failed.
- `401` — Unauthorized.
- `403` — Forbidden.

---

[API](https://skmtc.net/otterly/apis/otterly-public-api.md) · [All operations](https://skmtc.net/otterly/apis/otterly-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/otterly/otterly-public-api/revisions/49f12c5f26c7/schema)