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

# List a brand's topics with their metrics and prompt counts



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/brands/{brand_id}/topics
openapi: 3.0.1
info:
  title: Cognizo Public API
  version: v1
  description: >-
    Public REST API for Cognizo. Authenticate with an API key via the
    `X-API-KEY` header.
servers:
  - url: https://core.cognizo.ai
security:
  - apiKey: []
paths:
  /api/v2/brands/{brand_id}/topics:
    parameters:
      - name: brand_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Topics
      summary: List a brand's topics with their metrics and prompt counts
      operationId: list_brand_topics
      parameters:
        - name: brand_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: filter[target_brand]
          in: query
          required: false
          description: >-
            Brand name whose mentions count as 'target' metrics (default: the
            brand's own name)
          schema:
            type: string
        - name: filter[brand_ids]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: >-
            Found-brand mapping ids — scopes which found-brand rows count toward
            visibility/SOV/sentiment and top_brands (denominators stay unscoped)
        - name: filter[provider_ids]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Provider ids to scope metrics to
        - name: filter[region_ids]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Region ids to scope metrics to
        - name: filter[topic_ids]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: 'Topic ids to scope the list to (default: all of the brand''s topics)'
        - name: filter[ran_at_start]
          in: query
          required: false
          description: >-
            Period start (default 30 days ago); previous period is derived for
            diffs
          schema:
            type: string
            format: date-time
        - name: filter[ran_at_end]
          in: query
          required: false
          description: Period end (default now)
          schema:
            type: string
            format: date-time
        - name: filter[get_empty]
          in: query
          required: false
          description: >-
            true also returns topics with no active prompts (zeroed metrics,
            prompt_count 0); default false
          schema:
            type: boolean
      responses:
        '200':
          description: topics returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/topic_extended'
                required:
                  - data
        '404':
          description: brand not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    topic_extended:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        visibility:
          type: number
        share_of_voice:
          type: number
        visibility_diff:
          type: number
          nullable: true
        sov_diff:
          type: number
          nullable: true
        sentiment:
          type: number
          nullable: true
        sentiment_diff:
          type: number
          nullable: true
        citation_share:
          type: number
          nullable: true
        citation_share_diff:
          type: number
          nullable: true
        prompt_count:
          type: integer
          description: Tracked prompts in the topic — wizard selected/total badge (#97)
        top_brands:
          type: array
          description: >-
            Top 3 found brands by visibility + the target brand when ranked
            lower
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              visibility:
                type: number
            required:
              - id
              - name
              - visibility
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
      required:
        - id
        - name
        - visibility
        - share_of_voice
        - visibility_diff
        - sov_diff
        - sentiment
        - sentiment_diff
        - citation_share
        - citation_share_diff
        - prompt_count
        - top_brands
        - created_at
        - updated_at
    error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                $ref: '#/components/schemas/error_detail'
          required:
            - code
            - message
      required:
        - error
    error_detail:
      type: object
      properties:
        field:
          type: string
          nullable: true
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
        - field
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY

````