curl ejecutable que puedes copiar
en tu propio código.
Si solo necesitas la referencia de endpoints (cada parámetro, cada métrica), consulta
la pestaña REST API. El Cookbook es la capa que está por encima
de eso: las cosas comunes que la gente quiere construir con la API.
Dale contexto a tu asistente de IA
¿Estás desarrollando con Claude, ChatGPT, Cursor u otro asistente de programación con IA? Pega esta URL. Es un índice compacto de cada página de esta documentación que tu asistente puede consultar cuando lo necesite:Qué necesitas
1
Una clave de API
Genera una en Settings → API Keys en la app de Profound. Consulta
Autenticación si todavía no tienes una.
2
Un ID de categoría
Cada consulta de informes está vinculada a una categoría. Consulta
Encuentra tu ID de categoría para
buscar uno por nombre.
3
El SDK de Python (opcional)
Las recetas usan el SDK de Python por defecto porque es la opción más común.
Instálalo con
pip install profound. Cada receta también tiene una pestaña curl
si prefieres llamar directamente a la REST API.Configuración inicial
Cada receta empieza construyendo un cliente como este (solo lo necesitas una vez por script, incluso si encadenas varias recetas):Convenciones usadas en todas las recetas
Tres cosas que debes tener claras antes de empezar. Aparecen en todas las recetas y confunden a la mayoría de los usuarios nuevos:end_date es exclusiva: súmale un día
end_date es exclusiva: súmale un día
La API interpreta
end_date al inicio del día, por lo que excluye la fecha
que envías. Para incluir todo el 2026-05-10, envía end_date="2026-05-11".Muestra el valor inclusivo a tus usuarios; envía +1 day a la API.Lee las posiciones del arreglo desde info.query, no del orden de la solicitud
Lee las posiciones del arreglo desde info.query, no del orden de la solicitud
Cada respuesta incluye No codifiques las posiciones de forma fija. El orden puede no coincidir con el que solicitaste.
info.query.metrics e info.query.dimensions,
que devuelven el orden exacto que usó la API al empaquetar los arreglos
metrics y dimensions de cada fila.La API no calcula las variaciones: lo haces tú
La API no calcula las variaciones: lo haces tú
Los cambios entre períodos (el
+1.0 pp en verde o rojo que ves en cada
tarjeta de KPI) se calculan en el cliente. Ejecuta la misma llamada dos veces (una para la
ventana actual y otra para la ventana anterior de igual duración) y calcula la diferencia
entre ambas puntuaciones en tu código.Antes de construir
Convenciones y trampas comunes
Límites de tasa, fechas de fin exclusivas, orden de
info.query, errores,
paginación. Léelo una vez y pégalo en tu asistente de IA.Modelo de datos
Cómo se relacionan Categories, Topics, Prompts, Tags, Assets y Personas.
Endpoints de un vistazo
Cada endpoint, sus métricas y dimensiones, y para qué sirve: una
página fácil de recorrer.
Cómo se calculan las métricas
La fórmula detrás de cada métrica, un ejemplo práctico y cómo reproducir
cada número desde la Answers API.
Por qué cambian los números pasados
Los temas, las etiquetas y las marcas se aplican desde tu configuración actual, por lo que
editar tu configuración cambia los números históricos.
Recetas
Configuración
Encuentra tu ID de categoría
Lista las categorías que tu clave puede ver y elige una de forma programática.
Lista tus activos propios
Obtén cada activo de una categoría con su indicador
is_owned y sus dominios.Visibilidad
Visibility Score de un activo
La puntuación de un activo para la ventana más el cambio respecto a la ventana anterior.
Visibilidad a lo largo del tiempo
Construye el gráfico de líneas diario, semanal o mensual de un activo.
Valor principal y diario, juntos
Obtén ambos a la vez. Entiende por qué son llamadas distintas.
Ranking Top-N
Clasifica cada activo de una categoría según cualquier métrica de visibilidad.
Compara con la competencia
Gráfico de varias líneas de cualquier conjunto de activos elegido manualmente.
Segmenta por modelo, región o persona
Desglosa la puntuación de un solo activo según la superficie de IA que respondió.
Citas
Citation Share y su variación
Participación de los dominios propios en todas las citas, con el cambio entre períodos.
Citation Share y volumen a lo largo del tiempo
Línea diaria de participación de los dominios propios y volumen diario total de citas,
ambos a partir de una sola llamada.
Citation Rank por dominio
Cada dominio citado clasificado por participación, con la columna de variación en pp por fila.