Requisitos previos
- Una clave de API de AthenaHQ con acceso al sitio web (Organización → pestaña API). Consulta la página de Autenticación. Para una tarea programada, la opción más segura es una clave dedicada con acceso limitado a este sitio web.
- El
website_idsobre el que quieres informar. Obtenlo conGET /api/v1/websites. - Una vista guardada en ese sitio web, creada en el panel.
Configuración
1
Buscar el ID de la vista guardada
id de la vista cuyo name te interesa. El ID se mantiene cuando alguien edita la vista en el panel, por lo que la exportación sigue esos cambios.2
Solicitar un mes de métricas de la vista
is_self: true) y cada competidor que selecciona la vista.3
Programar la tarea
Ejecuta la solicitud una vez al mes para el mes que acaba de finalizar y añade las filas, junto con el mes, a tu tabla. Por ejemplo, en Python:
Qué cifra coincide con el panel
La tarjeta Porcentaje de menciones del panel muestra de forma predeterminada el porcentaje relevante. En la API esrelative_mention_rate: las menciones de la marca divididas entre las respuestas que mencionan tu marca o uno de los competidores de la vista. mention_rate es el modo absoluto de la tarjeta: las menciones divididas entre todas las respuestas de la vista. Lee la entrada con is_self: true para tu propia marca.
Como el porcentaje relevante cuenta las respuestas que mencionan a cualquiera de los competidores de la vista, cambiar la lista de competidores de la vista también cambia tu propio porcentaje relevante, tanto en el panel como aquí.
Cómo se aplica la vista
- Fechas.
start_dateyend_datedeterminan el intervalo; se ignora el intervalo de fechas guardado con la vista. Envía fechas simples (YYYY-MM-DD).end_datees inclusiva. - Valores predeterminados. Como en el panel, la vista solo cuenta las consultas activas e incluye todos los modelos, salvo que indique otra cosa. Una solicitud sin
saved_view_idconserva los valores predeterminados de la API, que incluyen las consultas en pausa. - Sustituciones. Cualquier filtro que envíes junto a
saved_view_idsustituye el valor de la vista para ese campo. Por ejemplo,"models": ["chatgpt"]lee la vista solo para ChatGPT. - Filtros de otras páginas. Las páginas Consultas, Respuestas y Fuentes comparten las vistas guardadas. Los filtros que solo utilizan esas páginas, como el sentimiento o las etiquetas de fuentes, no cambian las métricas del panel ni las de aquí.
- Todas las métricas. El mismo
saved_view_idfunciona en todos los endpoints de métricas: porcentaje de menciones, cuota de voz, porcentaje de citas y posición, tanto acumuladas como en series temporales. Las herramientas de métricas de MCP (get_mention_rate_cumulativey las demás) también lo aceptan.