> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryprofound.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introducción

> Recetas de principio a fin para recrear los dashboards de Profound con la API pública.

El Cookbook es una colección de **recetas de principio a fin** que muestran cómo recrear
cada gráfico, KPI y tabla que ves en la app de Profound usando solo llamadas a la API
pública. Cada receta es independiente: enumera los endpoints exactos que usa,
explica la forma de la solicitud y muestra código Python y `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](/es/rest-api/introduction). 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:

```
https://docs.tryprofound.com/llms.txt
```

## Qué necesitas

<Steps>
  <Step title="Una clave de API">
    Genera una en **Settings → API Keys** en la app de Profound. Consulta
    [Autenticación](/es/rest-api/authentication) si todavía no tienes una.
  </Step>

  <Step title="Un ID de categoría">
    Cada consulta de informes está vinculada a una categoría. Consulta
    [Encuentra tu ID de categoría](/es/cookbook/setup/find-your-category-id) para
    buscar uno por nombre.
  </Step>

  <Step title="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.
  </Step>
</Steps>

## Configuración inicial

Cada receta empieza construyendo un cliente como este (solo lo necesitas
una vez por script, incluso si encadenas varias recetas):

<CodeGroup>
  ```python Python theme={null}
  import os
  from profound import Profound

  client = Profound(api_key=os.environ["PROFOUND_API_KEY"])
  ```

  ```bash curl theme={null}
  export PROFOUND_API_KEY=your_api_key_here
  ```
</CodeGroup>

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

<AccordionGroup>
  <Accordion title="end_date es exclusiva: súmale un día" icon="calendar">
    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.
  </Accordion>

  <Accordion title="Lee las posiciones del arreglo desde info.query, no del orden de la solicitud" icon="list-ol">
    Cada respuesta incluye `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.

    ```python theme={null}
    order = res.info.query["metrics"]   # e.g. ["visibility_score"]
    i = order.index("visibility_score")
    score = res.data[0].metrics[i]
    ```

    No codifiques las posiciones de forma fija. El orden puede no coincidir con el que solicitaste.
  </Accordion>

  <Accordion title="La API no calcula las variaciones: lo haces tú" icon="arrow-up-right">
    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.
  </Accordion>
</AccordionGroup>

## Antes de construir

<CardGroup cols={2}>
  <Card title="Convenciones y trampas comunes" icon="list-check" href="/es/cookbook/setup/conventions">
    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.
  </Card>

  <Card title="Modelo de datos" icon="sitemap" href="/es/cookbook/setup/data-model">
    Cómo se relacionan Categories, Topics, Prompts, Tags, Assets y Personas.
  </Card>

  <Card title="Endpoints de un vistazo" icon="table" href="/es/cookbook/setup/endpoints-at-a-glance">
    Cada endpoint, sus métricas y dimensiones, y para qué sirve: una
    página fácil de recorrer.
  </Card>

  <Card title="Cómo se calculan las métricas" icon="calculator" href="/es/cookbook/metrics/how-metrics-are-calculated">
    La fórmula detrás de cada métrica, un ejemplo práctico y cómo reproducir
    cada número desde la Answers API.
  </Card>

  <Card title="Por qué cambian los números pasados" icon="clock-rotate-left" href="/es/cookbook/metrics/why-past-numbers-change">
    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.
  </Card>
</CardGroup>

## Recetas

### Configuración

<CardGroup cols={2}>
  <Card title="Encuentra tu ID de categoría" icon="magnifying-glass" href="/es/cookbook/setup/find-your-category-id">
    Lista las categorías que tu clave puede ver y elige una de forma programática.
  </Card>

  <Card title="Lista tus activos propios" icon="house-flag" href="/es/cookbook/setup/list-owned-assets">
    Obtén cada activo de una categoría con su indicador `is_owned` y sus dominios.
  </Card>
</CardGroup>

### Visibilidad

<CardGroup cols={2}>
  <Card title="Visibility Score de un activo" icon="chart-simple" href="/es/cookbook/visibility/asset-visibility-score">
    La puntuación de un activo para la ventana más el cambio respecto a la ventana anterior.
  </Card>

  <Card title="Visibilidad a lo largo del tiempo" icon="chart-line" href="/es/cookbook/visibility/visibility-over-time">
    Construye el gráfico de líneas diario, semanal o mensual de un activo.
  </Card>

  <Card title="Valor principal y diario, juntos" icon="layer-group" href="/es/cookbook/visibility/headline-and-daily">
    Obtén ambos a la vez. Entiende por qué son llamadas distintas.
  </Card>

  <Card title="Ranking Top-N" icon="trophy" href="/es/cookbook/visibility/leaderboard">
    Clasifica cada activo de una categoría según cualquier métrica de visibilidad.
  </Card>

  <Card title="Compara con la competencia" icon="users" href="/es/cookbook/visibility/compare-competitors">
    Gráfico de varias líneas de cualquier conjunto de activos elegido manualmente.
  </Card>

  <Card title="Segmenta por modelo, región o persona" icon="filter" href="/es/cookbook/visibility/segment-by-model">
    Desglosa la puntuación de un solo activo según la superficie de IA que respondió.
  </Card>
</CardGroup>

### Citas

<CardGroup cols={2}>
  <Card title="Citation Share y su variación" icon="percent" href="/es/cookbook/citations/citation-share">
    Participación de los dominios propios en todas las citas, con el cambio entre períodos.
  </Card>

  <Card title="Citation Share y volumen a lo largo del tiempo" icon="chart-line" href="/es/cookbook/citations/citation-share-over-time">
    Línea diaria de participación de los dominios propios **y** volumen diario total de citas,
    ambos a partir de una sola llamada.
  </Card>

  <Card title="Citation Rank por dominio" icon="trophy" href="/es/cookbook/citations/top-citing-domains">
    Cada dominio citado clasificado por participación, con la columna de variación en pp por fila.
  </Card>
</CardGroup>
