> ## 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. # Taux de citation cumulé > Renvoie les pourcentages de taux de citation sur la période indiquée : part des réponses IA citant votre marque et vos concurrents comme sources. ## OpenAPI ````yaml fr/api-reference/openapi.json post /api/v1/metrics/citation-rate/cumulative 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/metrics/citation-rate/cumulative: post: tags: - Metrics summary: Taux de citation cumulé description: >- Renvoie les pourcentages de taux de citation sur la période indiquée : part des réponses IA citant votre marque et vos concurrents comme sources. operationId: getCumulativeCitationRate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CitationRateRequest' responses: '200': description: Réponse réussie avec les taux de citation content: application/json: schema: type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/CumulativeCitationRateEntry' required: - data example: data: Acme Corp: citation_rate: 28.5 is_self: true Competitor Inc: citation_rate: 15.2 is_self: false '400': description: Requête incorrecte — paramètres invalides content: application/json: schema: $ref: '#/components/schemas/Error' examples: missing_website_id: value: error: 'website_id: Required' missing_filters: value: error: 'filters: Required' '401': description: Non autorisé — clé API invalide ou absente content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Interdit — vous n’avez pas accès à ce site content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Unauthorized access to this website '404': description: Site 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: CitationRateRequest: type: object description: Corps de requête des taux de citation required: - website_id - filters properties: website_id: type: string format: uuid description: ID du site dont interroger les taux de citation example: 123e4567-e89b-12d3-a456-426614174000 filters: $ref: '#/components/schemas/MetricsApiFilters' 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' location_ids: - 123e4567-e89b-12d3-a456-426614174111 CumulativeCitationRateEntry: type: object description: Données de taux de citation d’une marque ou d’un concurrent properties: citation_rate: type: number description: Pourcentage du taux de citation (0 à 100) example: 28.5 is_self: type: boolean description: Vrai si l’entrée représente votre site suivi example: true Error: type: object description: Objet de réponse d’erreur required: - error properties: error: type: string description: Message expliquant l’erreur example: Unauthorized MetricsApiFilters: allOf: - $ref: '#/components/schemas/ApiFilters' - type: object description: >- Filtres des métriques : filtres communs de réponses et vue enregistrée facultative. properties: saved_view_id: type: string format: uuid description: >- Vue issue de `GET /api/v1/saved-views` à appliquer comme dans le tableau de bord, y compris ses valeurs par défaut de prompts actifs et tous modèles. Tout filtre aussi envoyé remplace sa valeur dans la vue. Les dates enregistrées sont ignorées : `start_date` et `end_date` fixent la période. `404` si la vue n’appartient pas à `website_id` ; `400` nomme les filtres non applicables, remplaçables en les envoyant explicitement. example: 123e4567-e89b-12d3-a456-426614174222 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 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 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.