> ## Documentation Index
> Fetch the complete documentation index at: https://docs.otterly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a brand report



## OpenAPI

````yaml https://data.otterly.ai/v1/openapi.json get /v1/reports/brand/{reportId}
openapi: 3.0.0
info:
  title: Otterly Public API
  version: 1.0.0
servers:
  - url: https://data.otterly.ai
security: []
tags:
  - name: Engines
  - name: Workspaces
  - name: Brand Reports
  - name: Audits
  - name: Accounts
paths:
  /v1/reports/brand/{reportId}:
    get:
      tags:
        - Brand Reports
      summary: Get a brand report
      parameters:
        - schema:
            type: string
            minLength: 1
            example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
            description: Brand report identifier.
          required: true
          description: Brand report identifier.
          name: reportId
          in: path
      responses:
        '200':
          description: The brand report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiBrandReport'
        '400':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiValidationErrorResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        '404':
          description: Report not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    PublicApiBrandReport:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
        workspaceId:
          type: string
        brand:
          type: string
        reportTitle:
          type: string
        brandVariations:
          type: array
          items:
            type: string
        brandDomain:
          type: string
        brandDomainVariations:
          type: array
          items:
            type: string
        brandDomainWildcard:
          type: boolean
        countries:
          type: array
          items:
            type: string
          description: >-
            Lowercase ISO 3166-1 alpha-2 country codes the report tracks (e.g.
            `us`, `de`), with `uk` used in place of `gb`.
        createdDate:
          type: string
        updatedDate:
          type: string
        promptIds:
          type: array
          items:
            type: string
        countryPromptsTotal:
          type: object
          additionalProperties:
            type: number
          description: >-
            Total prompt count keyed by country code (lowercase ISO 3166-1
            alpha-2; `uk` instead of `gb`).
        competitors:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiBrandCompetitor'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiBrandReportTag'
      required:
        - id
        - workspaceId
        - brand
        - brandDomain
        - countries
        - createdDate
        - updatedDate
      example:
        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
    PublicApiValidationErrorResponse:
      type: object
      properties:
        message:
          type: string
        target:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
              - code
      required:
        - message
        - target
        - errors
      example:
        message: Validation failed
        target: query
        errors:
          - path: country
            message: Required
            code: invalid_type
    PublicApiErrorResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      example:
        message: Report not found
    PublicApiBrandCompetitor:
      type: object
      properties:
        brand:
          type: string
          description: Competitor brand name.
        brandVariations:
          type: array
          items:
            type: string
        brandDomain:
          type: string
        brandDomainVariations:
          type: array
          items:
            type: string
        brandDomainWildcard:
          type: boolean
      required:
        - brand
        - brandVariations
        - brandDomain
        - brandDomainVariations
        - brandDomainWildcard
      example:
        brand: Nike
        brandVariations:
          - nike
          - Nike Inc.
        brandDomain: nike.com
        brandDomainVariations:
          - nike.de
          - nike.co.uk
        brandDomainWildcard: false
    PublicApiBrandReportTag:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
        name:
          type: string
        color:
          type: string
          description: >-
            Tag color (Ant Design preset color name, e.g. 'gold', 'orange',
            'magenta', 'green', 'blue').
      required:
        - id
        - name
        - color
      example:
        id: 01HX8AB3CDE4FG5HJ6KL7MN8PQ
        name: Running Shoes
        color: orange
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Provide your API key as a Bearer token: `Authorization: Bearer
        YOUR_API_KEY`.

````