Answer Engine Insights

Esta guía ofrece ejemplos prácticos de solicitudes comunes a la API. Todos los ejemplos usan formato JSON y requieren autenticación mediante clave de API.

Reemplaza your_api_key, your_category_id y your_company_name con tus valores reales. Los ID de categoría se pueden obtener desde /v1/org/categories.

Todos los ejemplos usan formatos de fecha simplificados. Para uso en producción, lee Rangos de fechas y zonas horarias para entender el manejo de zonas horarias y evitar errores comunes con los parámetros de fecha.

Informes de visibilidad

Obtén métricas de visibilidad y datos de rendimiento de empresas dentro de categorías específicas. Consulta la referencia completa del endpoint para ver todas las métricas, dimensiones y filtros disponibles.

Puntuación de visibilidad
Share of Voice
Posición promedio
Clasificación por tema
Filtrado combinado de etiquetas AND/OR

Tendencias de visibilidad de la empresa a lo largo del tiempo
Las 5 principales empresas por puntuación de visibilidad

Haz seguimiento del rendimiento de visibilidad de una empresa específica con granularidad diaria:

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "date_interval": "day",
  "metrics": ["visibility_score"],
  "dimensions": ["date"],
  "filters": [
    {
      "field": "asset_name",
      "operator": "is",
      "value": "your_company_name"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [0.45], "dimensions": ["2026-01-01"] },
    { "metrics": [0.48], "dimensions": ["2026-01-02"] },
    { "metrics": [0.52], "dimensions": ["2026-01-03"] },
    { "metrics": [0.51], "dimensions": ["2026-01-04"] },
    { "metrics": [0.55], "dimensions": ["2026-01-05"] },
    { "metrics": [0.58], "dimensions": ["2026-01-06"] },
    { "metrics": [0.60], "dimensions": ["2026-01-07"] }
  ]
}

Caso de uso: Supervisa los cambios diarios de rendimiento e identifica tendencias.

Obtén las 5 empresas con la puntuación de visibilidad más alta en una categoría:

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["visibility_score"],
  "dimensions": ["asset_name"],
  "pagination": {
    "limit": 5
  }
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [0.583], "dimensions": ["Company A"] },
    { "metrics": [0.343], "dimensions": ["Company B"] },
    { "metrics": [0.231], "dimensions": ["Company C"] },
    { "metrics": [0.216], "dimensions": ["Company D"] },
    { "metrics": [0.173], "dimensions": ["Company E"] }
  ]
}

Caso de uso: Identifica a los líderes del mercado y compárate con los de mejor rendimiento.

Share of Voice por plataforma
Share of Voice por región

Analiza la puntuación de visibilidad y el share of voice en distintas plataformas para una empresa específica:

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["visibility_score", "share_of_voice"],
  "dimensions": ["model"],
  "filters": [
    {
      "field": "asset_name",
      "operator": "is",
      "value": "your_company_name"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [0.72, 0.15], "dimensions": ["ChatGPT"] },
    { "metrics": [0.65, 0.12], "dimensions": ["Perplexity"] },
    { "metrics": [0.58, 0.09], "dimensions": ["Gemini"] },
    { "metrics": [0.41, 0.06], "dimensions": ["Claude"] }
  ]
}

Caso de uso: Comprende el rendimiento y las oportunidades específicas de cada plataforma.

Analiza la puntuación de visibilidad y el share of voice en distintas regiones para una empresa específica:

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["visibility_score", "share_of_voice"],
  "dimensions": ["region"],
  "filters": [
    {
      "field": "asset_name",
      "operator": "is",
      "value": "your_company_name"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    {
      "metrics": [0.85, 0.32],
      "dimensions": ["North America"]
    },
    {
      "metrics": [0.72, 0.28],
      "dimensions": ["Europe"]
    }
  ]
}

Caso de uso: Identifica fortalezas y debilidades regionales en la puntuación de visibilidad y el share of voice.

Principales empresas por posición promedio
Tendencias de posición promedio a lo largo del tiempo

Para replicar la vista de Posición promedio de la plataforma, se necesitan dos llamadas a la API. La plataforma muestra la posición promedio de los principales activos clasificados por visibilidad, no todos los activos ordenados por posición.Paso 1: Obtén los principales activos por puntuación de visibilidad:

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["visibility_score"],
  "dimensions": ["asset_name"],
  "order_by": { "visibility_score": "desc" },
  "pagination": { "limit": 50 }
}

Paso 2: Usa esos nombres de activos para obtener su posición promedio:

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["average_position"],
  "dimensions": ["asset_name"],
  "filters": [
    {
      "field": "asset_name",
      "operator": "in",
      "value": ["Company A", "Company B", "Company C", "Company D", "Company E"]
    }
  ],
  "order_by": { "average_position": "asc" }
}

Orden "asc": una posición más baja es mejor, por lo que el puesto n.º 1 tiene el valor más bajo. El filtro "in" usa los nombres de activos devueltos en el Paso 1.

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [1.6], "dimensions": ["Company A"] },
    { "metrics": [2.0], "dimensions": ["Company B"] },
    { "metrics": [2.2], "dimensions": ["Company C"] },
    { "metrics": [3.2], "dimensions": ["Company D"] },
    { "metrics": [3.5], "dimensions": ["Company E"] }
  ]
}

Caso de uso: Identifica las empresas mejor clasificadas y compárate con la competencia.

Haz seguimiento de la posición promedio de una empresa específica con granularidad diaria:

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "date_interval": "day",
  "metrics": ["average_position"],
  "dimensions": ["date"],
  "filters": [
    {
      "field": "asset_name",
      "operator": "is",
      "value": "your_company_name"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [2.5], "dimensions": ["2026-01-01"] },
    { "metrics": [2.3], "dimensions": ["2026-01-02"] },
    { "metrics": [2.1], "dimensions": ["2026-01-03"] },
    { "metrics": [2.0], "dimensions": ["2026-01-04"] },
    { "metrics": [2.2], "dimensions": ["2026-01-05"] },
    { "metrics": [2.4], "dimensions": ["2026-01-06"] },
    { "metrics": [2.2], "dimensions": ["2026-01-07"] }
  ]
}

Caso de uso: Supervisa los cambios diarios de clasificación e identifica tendencias.

Visibilidad por tema y prompt

Analiza la puntuación de visibilidad y el share of voice en distintos temas y tipos de prompt para una empresa específica:

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["visibility_score", "share_of_voice"],
  "dimensions": ["prompt", "topic"],
  "filters": [
    {
      "field": "asset_name",
      "operator": "is",
      "value": "your_company_name"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    {
      "metrics": [0.45, 0.88],
      "dimensions": ["What is the best CRM software?", "CRM Software"]
    },
    {
      "metrics": [0.38, 0.75],
      "dimensions": ["Top project management tools for teams", "Project Management"]
    },
    {
      "metrics": [0.30, 0.62],
      "dimensions": ["Best enterprise collaboration platforms", "Collaboration"]
    }
  ]
}

Caso de uso: Analiza la puntuación de visibilidad y el share of voice en distintos temas y tipos de prompt para una empresa específica.

Combina varios grupos de etiquetas para segmentar una categoría mediante la intersección de dimensiones independientes.Cada filtro del arreglo filters acota el resultado. Para expresar OR dentro de un grupo, enumera los valores en un único filtro in. Para expresar AND entre grupos, envía varios filtros in sobre el mismo campo.

POST /v1/reports/visibility HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["share_of_voice"],
  "dimensions": ["asset_name"],
  "filters": [
    {
      "field": "tag_id",
      "operator": "in",
      "value": [
        "tag_id_product_a",
        "tag_id_product_b",
        "tag_id_product_c"
      ]
    },
    {
      "field": "tag_id",
      "operator": "in",
      "value": ["tag_id_product_d"]
    }
  ]
}

Esto coincide con los prompts etiquetados con al menos una de product_a, product_b o product_c y además etiquetados con tag_id_product_d. Forma booleana equivalente: (product_a OR product_b OR product_c) AND tag_id_product_d.

Un único filtro in que enumere los cuatro ID de etiqueta significaría “cualquiera de estos cuatro”: (product_a OR product_b OR product_c OR tag_id_product_d)

Análisis de sentimiento

Analiza datos de sentimiento y respuestas emocionales entre empresas y temas. Consulta la referencia completa del endpoint para ver todas las métricas, dimensiones y filtros disponibles.

La misma composición de filtros que se muestra en la pestaña Filtrado combinado de etiquetas AND/OR en Informes de visibilidad funciona en este endpoint.

Las 5 principales empresas por sentimiento positivo
Sentimiento de la empresa por tema

Identifica las empresas con el sentimiento más positivo:

POST /v1/reports/sentiment HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["positive"],
  "dimensions": ["asset_name"],
  "pagination": { "limit": 5 }
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [2413], "dimensions": ["Company A"] },
    { "metrics": [1856], "dimensions": ["Company B"] },
    { "metrics": [1204], "dimensions": ["Company C"] },
    { "metrics": [987], "dimensions": ["Company D"] },
    { "metrics": [714], "dimensions": ["Company E"] }
  ]
}

Las métricas de sentimiento son recuentos enteros, no porcentajes como la visibilidad. positive = recuento de instancias de sentimiento positivo para ese activo.Métricas de sentimiento disponibles: positive, negative, occurrences (recuento total).

Caso de uso: Comprende qué empresas tienen la mejor reputación y sentimiento.

Analiza el sentimiento positivo y negativo en distintos temas para una empresa específica:

POST /v1/reports/sentiment HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "metrics": ["positive", "negative"],
  "dimensions": ["theme"],
  "pagination": {
    "limit": 5
  },
  "filters": [
    {
      "field": "asset_name",
      "operator": "is",
      "value": "your_company_name"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    {
      "metrics": [12, 45],
      "dimensions": ["Customer Support"]
    },
    {
      "metrics": [8, 32],
      "dimensions": ["Pricing"]
    },
    {
      "metrics": [6, 28],
      "dimensions": ["Ease of Use"]
    },
    {
      "metrics": [4, 50],
      "dimensions": ["Product Quality"]
    },
    {
      "metrics": [2, 18],
      "dimensions": ["Integration"]
    }
  ]
}

Caso de uso: Identifica los temas que impulsan el sentimiento positivo o negativo para realizar mejoras específicas.

Informes de citas

Haz seguimiento de menciones, referencias y patrones de citas en dominios y páginas. Consulta la referencia completa del endpoint para ver todas las métricas, dimensiones y filtros disponibles.

La misma composición de filtros que se muestra en la pestaña Filtrado combinado de etiquetas AND/OR en Informes de visibilidad funciona en este endpoint.

Cuota de citas
Categorías y dominios de citas

Cuota de citas a lo largo del tiempo
Los 5 principales dominios por cuota de citas

Haz seguimiento de la cuota de citas por dominio con granularidad diaria:

POST /v1/reports/citations HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-04-08",
  "end_date": "2026-04-15",
  "metrics": ["citation_share"],
  "dimensions": ["date", "hostname"],
  "date_interval": "day",
  "order_by": { "date": "asc" }
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [0.092], "dimensions": ["2026-04-08 00:00:00", "example-a.com"] },
    { "metrics": [0.028], "dimensions": ["2026-04-08 00:00:00", "example-b.com"] },
    { "metrics": [0.021], "dimensions": ["2026-04-08 00:00:00", "example-c.com"] },
    { "metrics": [0.018], "dimensions": ["2026-04-08 00:00:00", "example-d.com"] },
    { "metrics": [0.015], "dimensions": ["2026-04-08 00:00:00", "example-e.com"] },
    { "metrics": [0.105], "dimensions": ["2026-04-09 00:00:00", "example-a.com"] },
    { "metrics": [0.030], "dimensions": ["2026-04-09 00:00:00", "example-b.com"] },
    { "metrics": [0.024], "dimensions": ["2026-04-09 00:00:00", "example-c.com"] },
    { "metrics": [0.019], "dimensions": ["2026-04-09 00:00:00", "example-d.com"] },
    { "metrics": [0.013], "dimensions": ["2026-04-09 00:00:00", "example-e.com"] },
    { "metrics": [0.088], "dimensions": ["2026-04-10 00:00:00", "example-a.com"] },
    { "metrics": [0.026], "dimensions": ["2026-04-10 00:00:00", "example-b.com"] }
  ]
}

Caso de uso: Supervisa cómo evoluciona la cuota de citas a lo largo del tiempo entre dominios competidores.

Obtén los 5 principales dominios clasificados por cuota de citas con el recuento total de citas:

POST /v1/reports/citations HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-04-08",
  "end_date": "2026-04-15",
  "metrics": ["citation_share", "count"],
  "dimensions": ["hostname"],
  "order_by": { "citation_share": "desc" },
  "pagination": { "limit": 5 }
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [0.087, 358], "dimensions": ["example-a.com"] },
    { "metrics": [0.025, 102], "dimensions": ["example-b.com"] },
    { "metrics": [0.023, 95], "dimensions": ["example-c.com"] },
    { "metrics": [0.019, 78], "dimensions": ["example-d.com"] },
    { "metrics": [0.015, 61], "dimensions": ["example-e.com"] }
  ]
}

Caso de uso: Identifica los dominios más citados de tu categoría y su cuota relativa.

Categorías de citas
Los 10 principales dominios de citas

Obtén la cuota y el recuento de citas desglosados por categoría de cita:

POST /v1/reports/citations HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-04-08",
  "end_date": "2026-04-15",
  "metrics": ["citation_share", "count"],
  "dimensions": ["citation_category"],
  "order_by": { "citation_share": "desc" }
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [0.136, 542], "dimensions": ["Earned Media"] },
    { "metrics": [0.115, 458], "dimensions": ["Social"] },
    { "metrics": [0.079, 315], "dimensions": ["Owned"] },
    { "metrics": [0.053, 211], "dimensions": ["Competition"] },
    { "metrics": [0.034, 136], "dimensions": ["Blog"] },
    { "metrics": [0.028, 112], "dimensions": ["Partner"] },
    { "metrics": [0.024, 96], "dimensions": ["Distribution"] },
    { "metrics": [0.020, 80], "dimensions": ["Documentation"] },
    { "metrics": [0.016, 64], "dimensions": ["Press"] },
    { "metrics": [0.012, 48], "dimensions": ["Video"] },
    { "metrics": [0.010, 40], "dimensions": ["other"] }
  ]
}

Caso de uso: Comprende qué categorías de citas generan más menciones en tu categoría.

Obtén los 10 dominios más citados por cuota y recuento de citas, agrupados por categoría de cita:

POST /v1/reports/citations HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-04-08",
  "end_date": "2026-04-15",
  "metrics": ["citation_share", "count"],
  "dimensions": ["citation_category", "hostname"],
  "order_by": { "citation_share": "desc" },
  "pagination": { "limit": 10 }
}

{
  "info": {},  // removed for brevity
  "data": [
    { "metrics": [0.038, 152], "dimensions": ["Earned Media", "example-a.com"] },
    { "metrics": [0.035, 140], "dimensions": ["Social", "example-f.com"] },
    { "metrics": [0.028, 112], "dimensions": ["Earned Media", "example-b.com"] },
    { "metrics": [0.025, 100], "dimensions": ["Earned Media", "example-c.com"] },
    { "metrics": [0.024, 96], "dimensions": ["Social", "example-g.com"] },
    { "metrics": [0.021, 84], "dimensions": ["other", "example-d.com"] },
    { "metrics": [0.018, 72], "dimensions": ["Social", "example-h.com"] },
    { "metrics": [0.015, 60], "dimensions": ["Earned Media", "example-e.com"] }
  ]
}

Caso de uso: Identifica los 10 dominios más citados y la categoría de cita a la que pertenecen.

Acceso a datos sin procesar

Accede a datos de prompts y respuestas sin procesar para análisis personalizados. Consulta la referencia completa del endpoint para ver todos los parámetros y filtros disponibles.

Respuestas de visibilidad
Respuestas de sentimiento

Obtén todas las respuestas de visibilidad para un rango de fechas:

POST /v1/prompts/answers HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "filters": [
    {
      "field": "prompt_type",
      "operator": "is",
      "value": "visibility"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    {
      "created_at": "2026-01-01T08:15:00Z",
      "prompt": "What are the best project management tools?",
      "mentions": ["Company A", "Company B", "Company C"],
      "prompt_type": "open-ended",
      "response": "There are several leading project management tools available today. Company A offers comprehensive project tracking with built-in collaboration features...",
      "citations": ["https://www.example.com/reviews", "https://www.example.com/best-tools"],
      "themes": ["feature comparison", "pricing"],
      "topic": "Project Management",
      "region": "North America",
      "model": "ChatGPT",
      "model_id": "3f8a1b2c-1234-5678-abcd-ef0123456789",
      "asset": "Company A"
    },
    ...
  ]
}

Caso de uso: Crea paneles personalizados y realiza análisis especializados con datos de respuestas sin procesar.

Obtén las respuestas a prompts de sentimiento filtradas por un activo específico:

POST /v1/prompts/answers HTTP/1.1
Content-Type: application/json
X-API-Key: your_api_key

{
  "category_id": "your_category_id",
  "start_date": "2026-01-01",
  "end_date": "2026-01-07",
  "filters": [
    {
      "field": "prompt_type",
      "operator": "is",
      "value": "sentiment"
    },
    {
      "field": "asset_name",
      "operator": "is",
      "value": "your_company_name"
    }
  ]
}

{
  "info": {},  // removed for brevity
  "data": [
    {
      "created_at": "2026-01-02T11:30:00Z",
      "prompt": "What do users think about Company A's analytics features?",
      "mentions": ["Company A"],
      "prompt_type": "brand-direct",
      "response": "Users generally have positive feedback about Company A's analytics capabilities. The platform is praised for its comprehensive dashboard and intuitive reporting features...",
      "citations": ["https://www.example.com/review/company-a"],
      "themes": ["analytics quality", "ease of use"],
      "topic": "Product Feedback",
      "region": "Europe",
      "model": "Perplexity",
      "model_id": "c4d5e6f7-3456-7890-cdef-012345678901",
      "asset": "Company A"
    },
    ...
      ]
}

Caso de uso: Analiza respuestas de sentimiento sin procesar de una marca específica en distintos modelos y regiones.

Descripción general

SDKs

Integraciones

Agentes

Organización

Categorías

Prompts

Bases de conocimiento

OpenAI Ads

Respuestas

Volúmenes de prompts

Informes

Optimización de contenido

Answer Engine Insights

Informes de visibilidad

Análisis de sentimiento

Informes de citas

Acceso a datos sin procesar

​Informes de visibilidad

​Análisis de sentimiento

​Informes de citas

​Acceso a datos sin procesar

Informes de visibilidad

Análisis de sentimiento

Informes de citas

Acceso a datos sin procesar