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

# Per-query statistics

> Returns per-query statistics for the project; to fetch a single query, pass `queryIds: [id]` and read `queries[0]`.



## OpenAPI

````yaml https://api.mentionlab.io/api/docs-json post /api/v1/analytics/queries/stats
openapi: 3.0.0
info:
  title: MentionLab Public API v0.3.4-rc
  description: ''
  version: 0.3.4-rc
  contact: {}
servers:
  - url: https://api.mentionlab.io
security: []
tags: []
paths:
  /api/v1/analytics/queries/stats:
    post:
      tags:
        - Analytics - Queries
      summary: Per-query statistics
      description: >-
        Returns per-query statistics for the project; to fetch a single query,
        pass `queryIds: [id]` and read `queries[0]`.
      operationId: QueriesStatsV1Controller_getStats_v1
      parameters:
        - name: x-project-id
          in: header
          description: Project ID to specify the project context
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueriesStatsDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueriesStatsResponse'
        '400':
          description: >-
            The request failed validation — the body, query or path parameters
            are malformed or out of range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: The request is missing valid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: >-
            The authenticated principal lacks the required permission, or access
            to the requested organisation/project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
components:
  schemas:
    QueriesStatsDto:
      type: object
      properties:
        startDate:
          type: string
          description: Start date (inclusive)
          example: '2025-01-01'
        endDate:
          type: string
          description: End date (exclusive)
          example: '2025-02-01'
        countries:
          description: Filter by country codes
          example:
            - BE
            - FR
          type: array
          items:
            type: string
        languages:
          description: Filter by language codes
          example:
            - en
            - fr
          type: array
          items:
            type: string
        models:
          description: Filter by AI models
          example:
            - gpt-4o
            - claude-3-5-sonnet
          type: array
          items:
            type: string
        queryIds:
          description: Filter by query IDs
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: array
          items:
            type: string
        hasSources:
          type: string
          description: >-
            Filter by source presence: "sources" (only with sources),
            "no_sources" (only without), "all" (no filter). Legacy true/false
            values are still accepted.
          enum:
            - all
            - sources
            - no_sources
        hasShopping:
          type: string
          description: >-
            Filter by shopping presence: "shopping" (only with shopping),
            "no_shopping" (only without), "all" (no filter). Legacy true/false
            values are still accepted.
          enum:
            - all
            - shopping
            - no_shopping
        queryTagIds:
          description: Filter by query tag IDs (numeric — bigint column)
          example:
            - '42'
          type: array
          items:
            type: string
        execTagIds:
          description: Filter by execution tag IDs
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: array
          items:
            type: string
        queryTagGroupIds:
          description: >-
            Filter by query tag group IDs — matches rows carrying any tag filed
            under a selected group. Combines with queryTagIds per queryTagMode.
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: array
          items:
            type: string
        execTagGroupIds:
          description: >-
            Filter by execution tag group IDs — matches rows carrying any tag
            filed under a selected group. Combines with execTagIds per
            execTagMode.
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: array
          items:
            type: string
        queryTypes:
          type: array
          description: >-
            Filter by query type. Include "untyped" to also match queries
            without a type. Results from since-deleted queries are excluded when
            this filter is set.
          items:
            type: string
            enum:
              - comparative
              - informative
              - perception
              - untyped
        queryTagMode:
          type: string
          description: >-
            Query tag matching mode: "or" matches ANY tag (default), "and"
            matches ALL tags.
          enum:
            - and
            - or
          default: or
        execTagMode:
          type: string
          description: >-
            Execution tag matching mode: "or" matches ANY tag (default), "and"
            matches ALL tags.
          enum:
            - and
            - or
          default: or
        timezone:
          type: string
          description: >-
            IANA timezone for date bucketing and filtering (e.g.
            "Europe/Brussels"). Defaults to UTC.
          example: Europe/Brussels
          default: UTC
        groupBy:
          type: string
          description: >-
            Row grouping level for entity results. "none" = one row per entity,
            "division" = one row per division (entities not in a division get
            their own row), "group" = one row per top-level group (divisions
            roll up into their group). Defaults to "none".
          enum:
            - none
            - division
            - group
        groupByEntityGroup:
          type: boolean
          description: >-
            Deprecated — use groupBy instead. true is equivalent to
            groupBy="group".
          deprecated: true
          example: false
        showAllEntities:
          type: boolean
          description: >-
            Include entities that have only ever been seen in a single AI
            response. These are mostly one-off extraction noise and are hidden
            by default.
          example: false
        entityIds:
          description: >-
            Entity IDs for the project brand (defaults to primary
            non-blacklisted)
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: array
          items:
            type: string
    QueriesStatsResponse:
      type: object
      properties:
        queries:
          description: Per-query statistics with brand metrics and source presence.
          type: array
          items:
            $ref: '#/components/schemas/QueryStatsPoint'
      required:
        - queries
    ApiErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code of the error.
          example: 400
        message:
          type: string
          description: >-
            Human-readable description of the error. Validation failures return
            an array of per-field validation errors instead of a single string.
          example: Validation failed
        error:
          type: string
          description: Short name of the HTTP error.
          example: Bad Request
      required:
        - statusCode
    QueryStatsPoint:
      type: object
      properties:
        queryId:
          type: string
          description: Query ID (UUID).
          example: 550e8400-e29b-41d4-a716-446655440000
        queryText:
          type: string
          description: The query/prompt text that was sent to the AI model.
          example: best CRM software
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code for the query locale.
          example: US
        language:
          type: string
          description: ISO 639-1 language code for the query locale.
          example: en
        type:
          description: >-
            The type of question the query asks. Null for queries that have not
            been classified.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/QueryType'
        resultCount:
          type: number
          description: >-
            Total number of AI responses for this query in the filtered scope
            (denominator for visibilityPct and sourcePresencePct).
          example: 42
        visibilityPct:
          type: number
          description: >-
            Project brand visibility — percentage of this query's AI responses
            that mention the project brand entities. Formula: (brand mention
            count / resultCount) × 100.
          example: 65.5
        avgSentiment:
          type: number
          description: >-
            Average sentiment score of the project brand mentions for this
            query. Scale: 0 (most negative) to 100 (most positive). Null when
            the brand was not mentioned in any response for this query.
          example: 72.3
          nullable: true
        avgRanking:
          type: number
          description: >-
            Average position rank of the project brand mentions for this query.
            Lower values mean the brand tends to appear higher/earlier in
            responses. Null when the brand was not mentioned in any response for
            this query.
          example: 3.2
          nullable: true
        sourcePresencePct:
          type: number
          description: >-
            Source presence — percentage of this query's AI responses that
            contain at least one source citation. Formula: (responses with
            sources / resultCount) × 100.
          example: 88.1
        shoppingPresencePct:
          type: number
          description: >-
            Shopping presence — percentage of this query's AI responses that
            contain at least one shopping result. Formula: (responses with
            shopping / resultCount) × 100.
          example: 24
        tagIds:
          description: IDs of the tags associated with this query.
          example:
            - '1'
            - '3'
          type: array
          items:
            type: string
      required:
        - queryId
        - queryText
        - country
        - language
        - type
        - resultCount
        - visibilityPct
        - avgSentiment
        - avgRanking
        - sourcePresencePct
        - shoppingPresencePct
    QueryType:
      type: string
      enum:
        - comparative
        - informative
        - perception
      description: >-
        The type of question the query asks: "comparative" (compares options),
        "informative" (seeks facts or how-to information) or "perception"
        (probes opinions about a brand).

````