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

# Page-level share overview (citation/mention series + page-type breakdown)



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/brands/{brand_id}/citations/pages/overview
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}/citations/pages/overview:
    parameters:
      - name: brand_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Citations
      summary: >-
        Page-level share overview (citation/mention series + page-type
        breakdown)
      operationId: get_brand_citations_pages_overview
      parameters:
        - name: filter[target_brand]
          in: query
          required: false
          description: >-
            Target brand name used for mention attribution. Defaults to the
            workspace brand's name.
          schema:
            type: string
        - name: filter[ran_at_start]
          in: query
          required: false
          description: Start of the ran_at window (ISO8601). Defaults to 30 days ago.
          schema:
            type: string
            format: date-time
        - name: filter[ran_at_end]
          in: query
          required: false
          description: End of the ran_at window (ISO8601). Defaults to end of today.
          schema:
            type: string
            format: date-time
        - name: filter[topic_ids]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: filter[brand_ids]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: filter[provider_ids]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: filter[region_ids]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: filter[granularity]
          in: query
          required: false
          schema:
            type: string
            enum:
              - day
              - week
              - month
          description: Period truncation for the time series (default day).
        - name: filter[domains]
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
          description: Restrict to these citation domains.
        - name: filter[prompt_id]
          in: query
          required: false
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: pages overview payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      your_citations:
                        allOf:
                          - $ref: '#/components/schemas/citation_share_time_series'
                          - type: object
                            properties:
                              count:
                                type: integer
                                nullable: true
                                description: Always null (legacy contract quirk).
                              delta_percent:
                                type: number
                                nullable: true
                                description: Always null (legacy contract quirk).
                            required:
                              - count
                              - delta_percent
                      your_mentions:
                        allOf:
                          - $ref: '#/components/schemas/citation_share_time_series'
                          - type: object
                            properties:
                              count:
                                type: integer
                                nullable: true
                                description: Always null (legacy contract quirk).
                              delta_percent:
                                type: number
                                nullable: true
                                description: Always null (legacy contract quirk).
                            required:
                              - count
                              - delta_percent
                      breakdown:
                        type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                            count:
                              type: integer
                            percent:
                              type: number
                          required:
                            - type
                            - count
                            - percent
                    required:
                      - your_citations
                      - your_mentions
                      - breakdown
                required:
                  - data
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    citation_share_time_series:
      type: object
      properties:
        current_value:
          type: number
        above_average:
          type: boolean
        data_points:
          type: array
          items:
            $ref: '#/components/schemas/citation_share_point'
      required:
        - current_value
        - above_average
        - data_points
    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
    citation_share_point:
      type: object
      properties:
        date:
          type: string
          description: Period start as 'YYYY-MM-DDT00:00:00' (local, no timezone offset).
        count:
          type: integer
        total:
          type: integer
        share_percent:
          type: number
        average_count:
          type: number
        average_percentage:
          type: number
      required:
        - date
        - count
        - total
        - share_percent
        - average_count
        - average_percentage
    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

````