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

# List YouTube performance by channel country

> Returns a paginated breakdown of YouTube citation performance by each cited channel's country; channels with no country are grouped together.



## OpenAPI

````yaml https://api.mentionlab.io/api/docs-json post /api/v1/analytics/social/youtube/countries
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/social/youtube/countries:
    post:
      tags:
        - Analytics - Social
      summary: List YouTube performance by channel country
      description: >-
        Returns a paginated breakdown of YouTube citation performance by each
        cited channel's country; channels with no country are grouped together.
      operationId: SocialV1Controller_listYoutubeCountries_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/YoutubeCountriesDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YoutubeCountriesResponse'
        '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:
    YoutubeCountriesDto:
      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
        page:
          type: number
          description: Page number (1-based).
          default: 1
          example: 1
        pageSize:
          type: number
          description: Items per page (max 200).
          default: 50
          example: 50
        sort:
          description: >-
            Sort options applied to the result. Sortable fields: country,
            citedChannelCount, citedVideoCount, citationCount, citationShare,
            citationRate, uniqueQueryCount.
          example:
            - field: citationCount
              direction: desc
          type: array
          items:
            $ref: '#/components/schemas/SortOptions'
    YoutubeCountriesResponse:
      type: object
      properties:
        globalYoutubeCitations:
          type: number
          description: >-
            Total distinct AI responses in scope that cited any YouTube video.
            Denominator for `citationShare`.
          example: 733
        totalResponses:
          type: number
          description: >-
            Total number of AI responses in the filtered scope. Used as the
            denominator for `citationRate`.
          example: 2140
        results:
          description: Per-country rows for the current page.
          type: array
          items:
            $ref: '#/components/schemas/YoutubeCountryListItem'
        page:
          description: Pagination metadata.
          allOf:
            - $ref: '#/components/schemas/Paging'
      required:
        - globalYoutubeCitations
        - totalResponses
        - results
        - page
    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
    SortOptions:
      type: object
      properties:
        field:
          type: string
          description: Field name to sort by
        direction:
          type: string
          enum:
            - ASC
            - DESC
          description: Sort direction
      required:
        - field
        - direction
    YoutubeCountryListItem:
      type: object
      properties:
        country:
          type: string
          description: >-
            ISO country code of the cited channel, from its latest snapshot.
            NULL groups channels that have no country assigned. This is the
            channel ORIGIN country — distinct from the request-level `country`
            filter, which scopes by the query/market country.
          nullable: true
          example: US
        citedChannelCount:
          type: number
          description: >-
            Distinct YouTube channels from this country whose videos were cited
            in scope.
          example: 12
        citedVideoCount:
          type: number
          description: Distinct YouTube videos from this country's channels cited in scope.
          example: 38
        citationCount:
          type: number
          description: >-
            Distinct AI responses in scope that cited any video from a channel
            in this country.
          example: 156
        citationShare:
          type: number
          description: >-
            This country's share of YouTube-video citations in scope. Formula:
            (citationCount / total AI responses citing any YT video in scope) ×
            100. Shares across countries can sum to >100% because one AI
            response may cite videos from channels in multiple countries. Null
            when no YouTube citations exist in scope (denominator = 0).
          nullable: true
          example: 21.28
        citationRate:
          type: number
          description: >-
            Citation rate — how often this country's channels appear across ALL
            AI responses in scope. Formula: (citationCount / totalResponses) ×
            100. Null when no AI responses exist in scope (denominator = 0).
          nullable: true
          example: 7.3
        uniqueQueryCount:
          type: number
          description: >-
            Distinct queries in scope whose AI responses cited any video from a
            channel in this country.
          example: 34
      required:
        - country
        - citedChannelCount
        - citedVideoCount
        - citationCount
        - citationShare
        - citationRate
        - uniqueQueryCount
    Paging:
      type: object
      properties:
        totalRecords:
          type: number
        limit:
          type: number
        currentPage:
          type: number
        totalPages:
          type: number
        nextPage:
          type: number
        prevPage:
          type: number
      required:
        - totalRecords
        - limit
        - currentPage
        - totalPages
        - nextPage
        - prevPage

````