> ## 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.

# Get a single prompt's metrics row

> Same computation as the prompts list, for one (prompt_id, region_id) pair.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/brands/{brand_id}/prompts/{prompt_id}/{region_id}
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}/prompts/{prompt_id}/{region_id}:
    parameters:
      - name: brand_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: prompt_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: region_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Prompts
      summary: Get a single prompt's metrics row
      description: >-
        Same computation as the prompts list, for one (prompt_id, region_id)
        pair.
      operationId: get_brand_prompt_region
      parameters:
        - name: filter[target_brand]
          in: query
          required: false
          schema:
            type: string
        - name: filter[brand_ids]
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: >-
            Found-brand restriction (legacy filter[brands]). Narrows visibility
            to these found_brand_ids.
        - name: filter[provider_ids]
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
          description: Provider restriction (legacy filter[providers]).
        - name: filter[is_deleted]
          in: query
          required: false
          description: >-
            Include soft-deleted prompt varieties (legacy filter[is_deleted]).
            Default false.
          schema:
            type: boolean
        - name: filter[ran_at_start]
          in: query
          required: false
          schema:
            type: string
            format: date-time
        - name: filter[ran_at_end]
          in: query
          required: false
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: prompt row
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/prompt_info'
                required:
                  - data
        '404':
          description: pair not tracked by this brand
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    prompt_info:
      type: object
      properties:
        prompt_id:
          type: string
          format: uuid
        prompt:
          type: string
        topic_name:
          type: string
        topic_id:
          type: string
          format: uuid
        region_id:
          type: string
          format: uuid
        country_code:
          type: string
        visibility:
          type: number
        visibility_diff:
          type: number
          nullable: true
        sentiment:
          type: number
          nullable: true
        sentiment_diff:
          type: number
          nullable: true
        mentioned:
          type: boolean
        top_competitors:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                nullable: true
              name:
                type: string
              visibility:
                type: number
              domain:
                type: string
                nullable: true
              sentiment:
                type: number
                nullable: true
              visibility_diff:
                type: number
                nullable: true
              sentiment_diff:
                type: number
                nullable: true
        last_run:
          type: string
          nullable: true
        volume:
          type: integer
          nullable: true
        volume_range:
          type: string
          nullable: true
          enum:
            - <10
            - 10-50
            - 50-150
            - 150-250
            - 250-500
            - 500-1k
            - 1k-2.5k
            - 2.5k-5k
            - 5k-15k
            - 15k-50k
            - 50k-150k
            - 150k-500k
            - 500k-1m
            - 1m+
            - null
          description: >-
            Bucketed label derived from `volume` (Volumes::VolumeRange); enum
            ordered smallest→largest.
        volume_confidence:
          type: number
          nullable: true
        volume_change:
          type: integer
          nullable: true
        volume_change_percent:
          type: number
          nullable: true
        citation_share:
          type: number
          nullable: true
        citation_share_diff:
          type: number
          nullable: true
        ads:
          type: array
          items:
            $ref: '#/components/schemas/ad'
      required:
        - prompt_id
        - prompt
        - topic_name
        - topic_id
        - region_id
        - country_code
        - visibility
        - mentioned
        - last_run
        - citation_share
        - citation_share_diff
        - ads
    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
    ad:
      type: object
      properties:
        ad_id:
          type: string
          format: uuid
        advertiser_id:
          type: string
          format: uuid
        advertiser_name:
          type: string
        advertiser_domain:
          type: string
        title:
          type: string
          nullable: true
        body:
          type: string
          nullable: true
        image_url:
          type: string
          nullable: true
        target_url:
          type: string
          nullable: true
        appearance_count:
          type: integer
        prompt_count:
          type: integer
        first_seen_at:
          type: string
          format: date-time
          nullable: true
        last_seen_at:
          type: string
          format: date-time
          nullable: true
      required:
        - ad_id
        - advertiser_id
        - advertiser_name
        - advertiser_domain
        - appearance_count
        - prompt_count
    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

````