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

# Brand Report

> Returns aggregated visibility, sentiment, and position metrics across all prompts under a brand.



## OpenAPI

````yaml POST /brand-report
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://app.mentionpilot.ai/api/v1
security:
  - bearerAuth: []
paths:
  /brand-report:
    post:
      summary: Brand Report
      description: >-
        Returns aggregated visibility, sentiment, and position metrics across
        all prompts under a brand.
      requestBody:
        description: Report parameters
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - brand_id
              properties:
                brand_id:
                  type: integer
                  description: ID of the brand to report on
                  example: 1
                date:
                  type: object
                  description: Optional date range filter.
                  properties:
                    from:
                      type: string
                      format: date
                      example: '2026-01-01'
                    to:
                      type: string
                      format: date
                      example: '2026-05-07'
                ai_agent:
                  type: array
                  description: Filter by AI agent(s). Omit to include all agents.
                  items:
                    type: string
                  example:
                    - chatgpt
                    - gemini
            example:
              brand_id: 1
              date:
                from: '2026-01-01'
                to: '2026-05-07'
              ai_agent:
                - chatgpt
                - gemini
      responses:
        '200':
          description: Brand report
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  brand:
                    type: string
                    example: MentionPilot
                  total_responses:
                    type: integer
                    description: Total number of AI responses analyzed
                    example: 120
                  visibility:
                    type: integer
                    description: Average visibility across all prompts (0–100)
                    example: 72
                  sentiment:
                    type: integer
                    description: Average sentiment score across all prompts (0–100)
                    example: 80
                  position:
                    type: number
                    description: Average brand position across all prompts
                    example: 2.5
              example:
                success: true
                brand: MentionPilot
                total_responses: 120
                visibility: 72
                sentiment: 80
                position: 2.5
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                success: false
                error: brand_id is required
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                success: false
                error: Access denied
        '404':
          description: Brand not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                success: false
                error: Brand not found
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: An error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````