Servicio de motor de consultas

Ejecución de análisis guardado

Información general

Puede usar el servicio Motor de consultas para ejecutar análisis guardados predefinidos por su identificador. El servicio no admite la ejecución dinámica de SQL, la ejecución de consultas por lotes o la ejecución de instrucciones arbitrarias.

Tipos de contenido

La API de REST de servicio está diseñada actualmente para admitir el siguiente tipo de contenido:

  • JSON - using Content-type: application/json

Seleccionar el tipo de contenido deseado es una elección que el desarrollador de API debe hacer caso por caso. La funcionalidad de la API es simétrica entre los tipos de contenido. Los desarrolladores de API pueden especificar el tipo de contenido deseado en los parámetros del método HTTP GET o POST o a través de su biblioteca de cliente AJAX o HTTP.

Comprobación de errores y códigos de estado

Los desarrolladores de API deben comprobar los códigos de respuesta HTTP devueltos desde la API REST de servicio para detectar errores propagados a partir de llamadas API. Las llamadas correctas al servicio darán como resultado códigos de respuesta de 200 intervalos. Las respuestas HTTP de rango 400 y 500 denotan errores. Es probable que los códigos de respuesta y el texto específicos experimenten cambios durante el desarrollo BETA de la API, sin embargo, los rangos no lo harán.

Seguridad

La API de servicio expone los datos de la aplicación de forma segura. El uso de la funcionalidad de la API está restringido a los usuarios autenticados y se expone a través de protocolos de transporte seguros. El acceso a la API debe realizarse en el siguiente contexto:

Autenticación

Para obtener más información sobre la autenticación, consulte API de Yield Analytics - Proceso de autenticación.

Confidencialidad

La confidencialidad se mantiene mediante el uso de la comunicación basada en Secure Socket Layer para interactuar con la API de Yield Analytics. Los desarrolladores de API deben preferir el uso de HTTPS sobre una comunicación insegura de HTTP siempre que sea posible. Consulte la biblioteca de clientes HTTP para saber cómo habilitar HTTP sobre SSL al desarrollar fuera del contexto de un explorador web.

Host

https://api.appnexus.com/imf/

Paths

Ejecutar análisis guardado

GET /api/v1/rest/queryengine/analysis/{savedAnalysisId}

  • Descripción

    Buscar un análisis guardado mediante su ID de informe.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter savedAnalysisId Identificador del análisis guardado true string

  • Ejemplo de solicitud de cURL

    $ curl --request GET \
  --url https://api.appnexus.com/imf/api/v1/rest/queryengine/analysis/100 \
  --header 'Authorization: {{auth-token}}' \
  --header 'content-type: application/json'

  • Ejemplo de solicitud HTTP

    GET /imf/api/v1/rest/queryengine/analysis/100 HTTP/1.1
Content-Type: application/json
Authorization: {{auth-token}}
Host: api.appnexus.com

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "row": [
    {
      "columnData": [
        {
          "name": "sample name",
          "value": "sample value"
        }
      ]
    }
  ]
}

Ejecutar análisis guardados con intervalo de fechas personalizado

GET api/v1/rest/queryengine/analysis/{savedAnalysisId}?start_date= {startDate}&end_date={endDate}
  • Descripción

Buscar un análisis guardado con un intervalo de fechas personalizado. Las fechas de inicio y finalización proporcionadas anulan la configuración de fecha almacenada con el informe.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter savedAnalysisId Identificador del análisis guardado true string
    PathParameter startDate La fecha de inicio del rango de datos solicitado (AAAA-MM-DD) true string
    PathParameter endDate La fecha de finalización del rango de datos solicitado (AAAA-MM-DD) true string

  • Ejemplo de solicitud de cURL

    $ curl --request GET \
  --url 'https://api.appnexus.com/imf/api/v1/rest/queryengine/analysis/100?start_date=2026-01-01&end_date=2026-01-31' \
  --header 'Authorization: {{auth-token}}' \
  --header 'content-type: application/json'

  • Ejemplo de solicitud HTTP

    GET /imf/api/v1/rest/queryengine/analysis/100?start_date=2026-01-01&end_date=2026-01-31 HTTP/1.1
Content-Type: application/json
Authorization: {{auth-token}}
Host: api.appnexus.com

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "row": [
    {
      "columnData": [
        {
          "name": "sample name",
          "value": "sample value"
        }
      ]
    }
  ]
}

Funcionalidad no compatible

No se admiten las siguientes funcionalidades del motor de consultas:

  • Ejecutar análisis dinámico
  • Ejecución de consultas por lotes
  • Ejecución directa de instrucciones SQL
  • Envío de consultas arbitrarias

Nota:

El servicio del motor de consultas está restringido a la ejecución de análisis guardados únicamente.

La funcionalidad de listado de productos está disponible a través de la API de GraphQL. Use GraphQL para recuperar una lista de productos y acceder a metadatos de nivel de producto mediante consultas y filtros estructurados. Consulte la documentación de la API de GraphQL para conocer las consultas admitidas y los detalles del esquema.

  • Last updated on