Servicio del motor de consultas

Ejecución de análisis guardada

Información general

Puede usar el servicio Del motor de consultas para ejecutar análisis guardados previamente definidos por su identificador. El servicio no admite la ejecución dinámica de SQL, la ejecución de consultas por lotes ni la ejecución de instrucciones arbitrarias.

Tipos de contenido

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

  • JSON: mediante Content-type: application/json

Seleccionar el tipo de contenido deseado es una opción que el desarrollador de la API debe tomar caso por caso. La funcionalidad de 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 cliente AJAX o HTTP.

Códigos de estado y comprobación de errores

Los desarrolladores de API deben comprobar los códigos de respuesta HTTP devueltos desde la API REST del servicio para detectar los errores propagados por las llamadas API. Las llamadas correctas al servicio generarán 200 códigos de respuesta de intervalo. Las respuestas HTTP de intervalo 400 y 500 denotan errores. Es probable que los códigos de respuesta y el texto específicos cambien durante el desarrollo beta de la API; sin embargo, los intervalos no.

Seguridad

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

Autenticación

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

Confidencialidad

La confidencialidad se mantiene mediante la comunicación basada en capa de socket seguro para interactuar con yield analytics API. Los desarrolladores de API deben preferir el uso de HTTPS en lugar de una comunicación HTTP insegura siempre que sea posible. Consulte la biblioteca cliente HTTP sobre cómo habilitar HTTP a través de SSL al desarrollar fuera de un contexto de explorador web.

Host

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

Paths

Ejecución del análisis guardado

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

  • Descripción

    Busque un análisis guardado con su identificador de informe.

  • Parámetros

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

  • Solicitud cURL de ejemplo

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

  • Solicitud HTTP de ejemplo

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

  • Respuesta HTTP de ejemplo

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

Ejecución del análisis guardado con intervalo de fechas personalizado

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

Busque un análisis guardado mediante un intervalo de fechas personalizado. Las fechas de inicio y finalización proporcionadas invalidan 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 Fecha de inicio del intervalo de datos solicitado (AAAA-MM-DD) true string
    PathParameter endDate Fecha de finalización del intervalo de datos solicitado (AAAA-MM-DD) true string

  • Solicitud cURL de ejemplo

    $ 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'

  • Solicitud HTTP de ejemplo

    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

  • Respuesta HTTP de ejemplo

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

Funcionalidad no admitida

No se admiten las siguientes funcionalidades del motor de consultas:

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

Nota:

El servicio Del motor de consultas solo está restringido a la ejecución de análisis guardados.

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

  • Last updated on