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

# Métriques cumulées des attributs

> Renvoie la prévalence par sens de chaque attribut neutre de perception. `positive` facultatif de premier niveau choisit observations positives/négatives, true par défaut. `total_responses` est le dénominateur : réponses de la période échantillonnées, analysées avec succès et mentionnant la marque. Une réponse analysée sans affirmation d’attribut étayée reste au dénominateur. Les attributs non mentionnés sont renvoyés avec response_count 0 plutôt qu’omis.



## OpenAPI

````yaml fr/api-reference/openapi.json post /api/v1/attributes/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/attributes/cumulative:
    post:
      tags:
        - Attributes
      summary: Métriques cumulées des attributs
      description: >-
        Renvoie la prévalence par sens de chaque attribut neutre de perception.
        `positive` facultatif de premier niveau choisit observations
        positives/négatives, true par défaut. `total_responses` est le
        dénominateur : réponses de la période échantillonnées, analysées avec
        succès et mentionnant la marque. Une réponse analysée sans affirmation
        d’attribut étayée reste au dénominateur. Les attributs non mentionnés
        sont renvoyés avec response_count 0 plutôt qu’omis.
      operationId: getCumulativeAttributeMetrics
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CumulativeAttributeMetricsRequest'
      responses:
        '200':
          description: Réponse réussie avec les métriques d’attributs
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AttributeMetric'
                required:
                  - data
              example:
                data:
                  - attribute_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    attribute_name: Affordable
                    positive: true
                    response_count: 12
                    total_responses: 40
                    percentage: 30
                  - attribute_id: 9c858901-8a57-4791-81fe-4c455b099bc9
                    attribute_name: Slow Support
                    positive: false
                    response_count: 0
                    total_responses: 40
                    percentage: 0
        '400':
          description: Requête incorrecte — paramètres invalides
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Non autorisé — clé API invalide ou absente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Interdit — la clé API ne peut pas accéder à ce site
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Introuvable — site ou attribut inexistant
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    CumulativeAttributeMetricsRequest:
      type: object
      properties:
        website_id:
          type: string
          format: uuid
        positive:
          type: boolean
          default: true
          description: Sens d’observation à sélectionner.
        filters:
          $ref: '#/components/schemas/ApiFiltersNoCompetitors'
      required:
        - website_id
        - filters
    AttributeMetric:
      type: object
      properties:
        attribute_id:
          type: string
          format: uuid
        attribute_name:
          type: string
          example: Affordable
        positive:
          type: boolean
        response_count:
          type: integer
          description: Nombre de réponses analysées mentionnant cet attribut.
        total_responses:
          type: integer
          description: Réponses analysées dans la période — le dénominateur.
        percentage:
          type: number
          description: response_count / total_responses, en pourcentage.
      required:
        - attribute_id
        - attribute_name
        - positive
        - response_count
        - total_responses
        - percentage
    Error:
      type: object
      description: Objet de réponse d’erreur
      required:
        - error
      properties:
        error:
          type: string
          description: Message expliquant l’erreur
          example: Unauthorized
    ApiFiltersNoCompetitors:
      type: object
      description: >-
        Filtres communs sans competitor_ids pour les attributs qui ne
        l’acceptent pas : /api/v1/attributes/cumulative concerne uniquement la
        marque ; /api/v1/attributes/observations choisit les entités via
        `entity_ids`. Envoyer competitor_ids est refusé. Utilisez
        /api/v1/attributes/competitors pour les métriques par concurrent.
      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
        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
      additionalProperties: false
    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.