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

# Lister les sources par domaine racine

> Renvoie les principales sources citées du site par domaine racine. Chaque ligne inclut citations, mentions, mentions de marque, impressions sur la période et `default_source_type` (`owned` / `competitor` / `partner` / `third_party`).

Complète [POST /api/v1/source-pages](/fr/api-reference/sources/list-source-pages-per-url), qui regroupe par URL, une ligne par page. Propriété et étiquettes suivent les règles centralisées de motifs d’URL. Les résumés de domaines ne considèrent que les règles d’hôte entier ; chemins et requêtes s’appliquent aux pages. Les hôtes www explicites restent distincts si leurs règles diffèrent de l’apex.



## OpenAPI

````yaml fr/api-reference/openapi.json post /api/v1/sources
openapi: 3.1.0
info:
  title: API AthenaHQ
  description: >-
    L’API AthenaHQ permet de gérer vos sites et prompts par programme pour
    l’optimisation de contenu par IA.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Serveur de production
security:
  - apiKey: []
tags:
  - name: Basics
    description: Opérations API principales pour gérer sites et prompts
  - name: Metrics
    description: Points de terminaison de métriques et analyses de visibilité IA
  - name: Billing
    description: Points de facturation et crédits pour gérer la consommation
  - name: Team Management
    description: Points de terminaison de gestion des membres et invitations
  - name: Groups
    description: Points de terminaison de gestion des groupes de sites
  - name: Content
    description: >-
      Points de terminaison Content Hub : onglets, URL suivies et détail des
      prompts par URL.
  - name: Pitch Workspace
    description: >-
      Points de terminaison des rapports Pitch Workspace : exécutions à
      l’échelle de l’organisation avec concurrents, prompts, attributs et
      métriques agrégées.
  - name: Knowledge Base
    description: >-
      Endpoints de lecture de la base de connaissances de la marque — faits
      approuvés et piliers qui les organisent.
paths:
  /api/v1/sources:
    post:
      tags:
        - Sources
      summary: Lister les sources par domaine racine
      description: >-
        Renvoie les principales sources citées du site par domaine racine.
        Chaque ligne inclut citations, mentions, mentions de marque, impressions
        sur la période et `default_source_type` (`owned` / `competitor` /
        `partner` / `third_party`).


        Complète [POST
        /api/v1/source-pages](/fr/api-reference/sources/list-source-pages-per-url),
        qui regroupe par URL, une ligne par page. Propriété et étiquettes
        suivent les règles centralisées de motifs d’URL. Les résumés de domaines
        ne considèrent que les règles d’hôte entier ; chemins et requêtes
        s’appliquent aux pages. Les hôtes www explicites restent distincts si
        leurs règles diffèrent de l’apex.
      operationId: listSources
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourcesListRequest'
      responses:
        '200':
          description: Réponse réussie avec la page de sources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcesListResponse'
              example:
                sources:
                  - root_domain: wikipedia.org
                    total_mentions: 124
                    response_count: 86
                    estimated_impressions: 18400
                    domain_count: 31
                    mention_percentage: 12.3
                    citation_percentage: 14.1
                    competitor_mention_percentage: 3.2
                    brand_mention_percentage: 8.9
                    mentions_count: 47
                    responses_mentioned_count: 39
                    competitor_ids: []
                    default_source_type: third_party
                    source_type_ids: []
                    first_seen: '2024-01-04'
                pagination:
                  page_num: 0
                  page_size: 30
                  total: 142
        '400':
          description: Requête incorrecte — paramètres invalides.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                missing_website_id:
                  value:
                    error: website_id is required
                invalid_website_id:
                  value:
                    error: website_id must be a uuid
        '401':
          description: Non autorisé — clé API invalide ou absente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Interdit — aucun accès au site, ou ID de sous-ressource
            (`prompt_ids`, `competitor_ids`, `location_ids`) d’un autre site.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                website:
                  value:
                    error: Unauthorized access to this website
                prompts:
                  value:
                    error: Unauthorized access to these prompts
        '404':
          description: Site web introuvable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Website not found
        '500':
          description: Erreur interne du serveur.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    SourcesListRequest:
      type: object
      description: Corps de liste des sources par domaine.
      required:
        - website_id
        - filters
      properties:
        website_id:
          type: string
          format: uuid
          description: Site web dont répertorier les sources.
          example: 123e4567-e89b-12d3-a456-426614174000
        filters:
          $ref: '#/components/schemas/ApiFilters'
        page_num:
          type: integer
          minimum: 0
          default: 0
          description: Numéro de page commençant à zéro.
        page_size:
          type: integer
          minimum: 1
          maximum: 100
          default: 30
          description: Nombre de lignes par page (1 à 100).
        sort_field:
          type: string
          enum:
            - citation_percentage
            - mention_percentage
            - competitor_mention_percentage
            - brand_mention_percentage
            - estimated_impressions
            - total_mentions
            - domain_count
            - mentions_count
            - root_domain
            - response_count
            - first_seen
          default: citation_percentage
          description: Colonne selon laquelle trier.
        sort_direction:
          type: string
          enum:
            - asc
            - desc
          default: desc
        search:
          type: string
          nullable: true
          description: >-
            Filtre de sous-chaîne sur `normalized_root_domain`. Protocole
            (`https://`), `www.`, chemin, requête et fragment retirés :
            `https://www.example.com/foo` devient `example.com`.
        mentioned:
          $ref: '#/components/schemas/SourcesMentionedFilter'
        competitors_mentioned:
          $ref: '#/components/schemas/SourcesMentionedFilter'
      example:
        website_id: 123e4567-e89b-12d3-a456-426614174000
        filters:
          start_date: '2024-01-01T00:00:00.000Z'
          end_date: '2024-01-31T23:59:59.999Z'
        page_size: 30
        sort_field: citation_percentage
        sort_direction: desc
    SourcesListResponse:
      type: object
      required:
        - sources
        - pagination
      properties:
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceItem'
        pagination:
          $ref: '#/components/schemas/SourcesPagination'
    Error:
      type: object
      description: Objet de réponse d’erreur
      required:
        - error
      properties:
        error:
          type: string
          description: Message expliquant l’erreur
          example: Unauthorized
    ApiFilters:
      type: object
      description: >-
        Filtres pour interroger les réponses et les indicateurs. Transmettez les
        filtres d’emplacements dans le corps JSON comme `filters.location_ids`.
      required:
        - start_date
      properties:
        schedule_id:
          $ref: '#/components/schemas/PromptScheduleSelection'
        start_date:
          type: string
          format: date-time
          description: Date de début du filtre (UTC)
          example: '2024-01-01T00:00:00.000Z'
        end_date:
          type: string
          format: date-time
          description: Date de fin du filtre (UTC)
          example: '2024-12-31T23:59:59.999Z'
        models:
          type: array
          description: Filtrer par modèles IA
          items:
            type: string
            enum:
              - chatgpt
              - perplexity
              - gemini
              - google_ai_overview
              - copilot
              - claude
              - ai_mode
              - grok
              - deepseek
              - meta_ai
              - mistral
          example:
            - chatgpt
            - perplexity
        prompt_ids:
          type: array
          description: Filtrer par ID de prompts précis
          items:
            type: string
            format: uuid
        competitor_ids:
          type: array
          description: Filtrer par ID de concurrents précis
          items:
            type: string
            format: uuid
        location_ids:
          type: array
          description: >-
            Filtre par ID d’emplacement dans le corps JSON sous
            `filters.location_ids`, même pour un seul. Utilisez les ID de `GET
            /api/v1/locations`.
          items:
            type: string
            format: uuid
          example:
            - 123e4567-e89b-12d3-a456-426614174111
        prompt_status:
          type: string
          enum:
            - active
            - paused
          description: Filtrer par statut du prompt
        prompt_type:
          type: string
          enum:
            - branded
            - non_branded
          description: Filtrer par type de prompt
    SourcesMentionedFilter:
      type: string
      enum:
        - 'yes'
        - 'no'
      description: >-
        Avec `yes`, compte uniquement les sources dont la réponse citante
        mentionne votre marque. Avec `no`, uniquement celles dont la réponse ne
        la mentionne PAS. Omettez le champ pour compter toutes les sources
        citées.
    SourceItem:
      type: object
      description: >-
        Ligne source par domaine, avec domaine racine cité, citations, mentions
        et impressions de la période.
      required:
        - root_domain
        - total_mentions
        - response_count
        - estimated_impressions
        - domain_count
        - mention_percentage
        - citation_percentage
        - competitor_mention_percentage
        - brand_mention_percentage
        - mentions_count
        - responses_mentioned_count
        - competitor_ids
        - default_source_type
        - source_type_ids
        - first_seen
      properties:
        root_domain:
          type: string
          description: Domaine racine cité, au format d’affichage.
          example: wikipedia.org
        total_mentions:
          type: number
          description: >-
            Total des citations du domaine sur la période, une par réponse
            citante.
          example: 124
        response_count:
          type: number
          description: Réponses IA distinctes citant ce domaine.
          example: 86
        estimated_impressions:
          type: number
          description: Impressions estimées attribuables à ce domaine sur la période.
          example: 18400
        domain_count:
          type: number
          description: Nombre de sous-domaines distincts regroupés sous ce domaine racine.
          example: 31
        mention_percentage:
          type: number
          description: >-
            Citations de ce domaine en pourcentage de toutes les réponses
            correspondantes.
          example: 12.3
        citation_percentage:
          type: number
          description: >-
            Même numérateur que `mention_percentage`. Conservé pour
            compatibilité avec la structure du tableau de bord existant.
          example: 14.1
        competitor_mention_percentage:
          type: number
          description: >-
            Parmi les réponses citant ce domaine, pourcentage mentionnant aussi
            un concurrent suivi.
          example: 3.2
        brand_mention_percentage:
          type: number
          description: >-
            Parmi les réponses citant ce domaine, pourcentage mentionnant la
            marque du site.
          example: 8.9
        mentions_count:
          type: number
          description: >-
            Agrégation par URL : nombre d’URL citées sur ce domaine où la marque
            a été mentionnée.
          example: 47
        responses_mentioned_count:
          type: number
          description: Nombre de réponses citantes mentionnant la marque.
          example: 39
        competitor_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Concurrents suivis mentionnés dans les réponses citant ce domaine.
          example: []
        default_source_type:
          $ref: '#/components/schemas/SourceTypeClassification'
        source_type_ids:
          type: array
          items:
            type: string
            format: uuid
          description: >-
            UUID d’étiquettes personnalisées associés au domaine, en plus de
            `default_source_type`.
          example: []
        first_seen:
          type: string
          description: Première date de citation de ce domaine dans la période.
          example: '2024-01-04'
    SourcesPagination:
      type: object
      description: >-
        Métadonnées de pagination. Contrairement à `Pagination` (qui utilise une
        anticipation `has_more`), les vues de sources exposent un nombre `total`
        précis — la requête ClickHouse sous-jacente le calcule comme fonction de
        fenêtre dans le même parcours, sans coût d’aller-retour supplémentaire.
      required:
        - page_num
        - page_size
        - total
      properties:
        page_num:
          type: integer
          description: Numéro de page renvoyé, à partir de zéro.
          example: 0
        page_size:
          type: integer
          description: Maximum d’éléments par page.
          example: 30
        total:
          type: integer
          description: >-
            Nombre total de lignes correspondant aux filtres (toutes pages
            confondues).
          example: 142
    PromptScheduleSelection:
      description: >-
        Sélectionnez une planification de collecte, avec la valeur renvoyée par
        GET /api/v1/prompt-schedules. Par défaut inclut l’historique antérieur à
        la transition et les exécutions ponctuelles ; les planifications
        archivées conservent leurs résultats. L’ancien jeton manual est accepté
        comme alias de default. Ce champ accepte une seule planification ; une
        liste renvoie 400.
      default: default
      oneOf:
        - type: string
          enum:
            - default
            - manual
        - type: string
          format: uuid
    SourceTypeClassification:
      type: string
      enum:
        - owned
        - competitor
        - partner
        - third_party
      description: >-
        Classement de la source par rapport au site. `owned` couvre son hôte,
        les hôtes déclarés propriétaires et leurs sous-domaines ; un motif
        propriétaire avec chemin (comme `reddit.com/user/brand`) ne classe que
        les pages sous ce chemin en `owned`, pas tout l’hôte. `competitor`
        correspond aux domaines racines concurrents suivis ; `partner` aux
        domaines affiliés configurés ; `third_party` au reste (Wikipédia,
        presse, etc.). Priorité des remplacements par site : URL exacte, puis
        hôte/chemin déclaré propriétaire qui reste `owned`, puis règle de
        domaine, y compris pour les hôtes `owned` uniquement comme sous-domaines
        d’un domaine déclaré.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clé API d’authentification. Créez-en une
        [ici](https://app.athenahq.ai/organization?tab=api).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.