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

# Porcentaje acumulado de citas

> Devuelve los porcentajes de citas del intervalo de fechas indicado. Muestra el porcentaje de respuestas de IA que citan tu marca y tus competidores como fuentes.



## OpenAPI

````yaml es/api-reference/openapi.json post /api/v1/metrics/citation-rate/cumulative
openapi: 3.1.0
info:
  title: API de AthenaHQ
  description: >-
    La API de AthenaHQ ofrece acceso programático para gestionar tus sitios web
    y consultas para optimizar el contenido con IA.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Servidor de producción
security:
  - apiKey: []
tags:
  - name: Basics
    description: Operaciones principales de la API para gestionar sitios web y consultas
  - name: Metrics
    description: Endpoints de métricas y análisis para monitorizar la visibilidad en IA
  - name: Billing
    description: Endpoints de facturación y créditos para gestionar el uso
  - name: Team Management
    description: Endpoints para gestionar miembros del equipo e invitaciones
  - name: Groups
    description: Endpoints para gestionar grupos de sitios web
  - name: Content
    description: >-
      Endpoints para acceder a los datos del centro de contenidos: pestañas, URL
      monitorizadas y desglose de consultas por URL.
  - name: Pitch Workspace
    description: >-
      Endpoints para acceder a los informes del espacio de propuestas:
      ejecuciones de propuestas con alcance de organización, con competidores,
      consultas, atributos y métricas agregadas.
  - name: Knowledge Base
    description: >-
      Endpoints para leer la base de conocimientos de la marca: datos aprobados
      sobre la marca y los pilares que los organizan.
paths:
  /api/v1/metrics/citation-rate/cumulative:
    post:
      tags:
        - Metrics
      summary: Porcentaje acumulado de citas
      description: >-
        Devuelve los porcentajes de citas del intervalo de fechas indicado.
        Muestra el porcentaje de respuestas de IA que citan tu marca y tus
        competidores como fuentes.
      operationId: getCumulativeCitationRate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CitationRateRequest'
      responses:
        '200':
          description: Respuesta correcta con datos del porcentaje de citas
          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: 'Solicitud incorrecta: parámetros no válidos'
          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: 'Sin autorización: falta la clave de API o no es válida'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Acceso denegado: no tienes acceso a este sitio web'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Unauthorized access to this website
        '404':
          description: Sitio web no encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Website not found
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    CitationRateRequest:
      type: object
      description: Cuerpo de la solicitud de los endpoints de porcentaje de citas
      required:
        - website_id
        - filters
      properties:
        website_id:
          type: string
          format: uuid
          description: ID del sitio web cuyos porcentajes de citas se quieren consultar
          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: Datos del porcentaje de citas de una marca o un competidor
      properties:
        citation_rate:
          type: number
          description: Porcentaje de citas (0-100)
          example: 28.5
        is_self:
          type: boolean
          description: True si esta entrada representa tu sitio web monitorizado
          example: true
    Error:
      type: object
      description: Objeto de respuesta de error
      required:
        - error
      properties:
        error:
          type: string
          description: Mensaje de error que describe qué ha fallado
          example: Unauthorized
    MetricsApiFilters:
      allOf:
        - $ref: '#/components/schemas/ApiFilters'
        - type: object
          description: >-
            Filtros para los endpoints de métricas: los filtros compartidos de
            respuestas más una vista guardada opcional.
          properties:
            saved_view_id:
              type: string
              format: uuid
              description: >-
                Vista guardada que se aplicará, de `GET /api/v1/saved-views`.
                Sus filtros se aplican como en el panel, incluidos los valores
                predeterminados de consultas activas y todos los modelos. Un
                filtro enviado explícitamente sustituye el valor de la vista
                para ese campo. Se ignora su intervalo guardado: lo deciden
                `start_date` y `end_date`. Devuelve `404` si la vista no
                pertenece a `website_id`, y `400` identificando filtros que la
                API no puede aplicar y que puedes sustituir explícitamente.
              example: 123e4567-e89b-12d3-a456-426614174222
    ApiFilters:
      type: object
      description: >-
        Filtros para consultar respuestas y métricas. Pasa los filtros de
        ubicación en el cuerpo JSON como `filters.location_ids`.
      required:
        - start_date
      properties:
        schedule_id:
          $ref: '#/components/schemas/PromptScheduleSelection'
        start_date:
          type: string
          format: date-time
          description: Fecha de inicio del filtro (UTC)
          example: '2024-01-01T00:00:00.000Z'
        end_date:
          type: string
          format: date-time
          description: Fecha de fin del filtro (UTC)
          example: '2024-12-31T23:59:59.999Z'
        models:
          type: array
          description: Filtrar por modelos de 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: Filtrar por IDs de consultas concretas
          items:
            type: string
            format: uuid
        competitor_ids:
          type: array
          description: Filtrar por IDs de competidores concretos
          items:
            type: string
            format: uuid
        location_ids:
          type: array
          description: >-
            Filtra por ID de ubicaciones. Pásalo en el cuerpo JSON como
            `filters.location_ids`, incluso para una sola ubicación. Usa los ID
            devueltos por `GET /api/v1/locations`.
          items:
            type: string
            format: uuid
          example:
            - 123e4567-e89b-12d3-a456-426614174111
        prompt_status:
          type: string
          enum:
            - active
            - paused
          description: Filtrar por estado de la consulta
        prompt_type:
          type: string
          enum:
            - branded
            - non_branded
          description: Filtrar por tipo de consulta
    PromptScheduleSelection:
      description: >-
        Selecciona una programación de recopilación. Usa la selección devuelta
        por GET /api/v1/prompt-schedules. La predeterminada incluye el historial
        anterior al cambio y ejecuciones puntuales; las archivadas conservan
        resultados. El antiguo token manual se admite como alias de default.
        Solo acepta una programación; una lista devuelve 400.
      default: default
      oneOf:
        - type: string
          enum:
            - default
            - manual
        - type: string
          format: uuid
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clave de API para autenticarse. Puedes crear una
        [aquí](https://app.athenahq.ai/organization?tab=api).

````

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