Servicio del motor de consultas

Artículo
05/18/2024

Información general

La API y los servicios de Yield Analytics se exponen a través de una interfaz basada en REST. Está diseñado para que el desarrollo de funcionalidad personalizada sea cómodo para los desarrolladores experimentados con plataformas de desarrollo orientadas a servicios, AJAX, REST y Web 2.0. Los desarrolladores deben estar familiarizados con los paradigmas de aplicación basados en web, como AJAX, XML, JSON y el protocolo HTTP(S) antes de intentar el desarrollo con la API y los servicios de Yield Analytics.

El servicio Motor de consultas permite al desarrollador de la API acceder a un motor muy flexible para consultar datos del sistema Yield Analytics con el fin de realizar casos de uso que no se tienen en cuenta con las API de detección de productos e inventario. Aunque la flexibilidad y la potencia del servicio del motor de consultas permiten realizar muchos casos de uso, solo los usuarios con conocimientos profundos deben intentar formar una consulta del motor de consulta para asegurarse de que se extraen datos válidos. Póngase en contacto con el servicio de atención al cliente de Yield Analytics para ayudarle a desarrollar las expresiones de consulta necesarias para lograr el objetivo de los datos.

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:

Ejemplo de autenticación cURL

La autenticación se produce pasando credenciales a través de encabezados HTTP en cada solicitud.
```
- username: curl -H "username:username"
- password: curl -H "password:password"
- source: curl -H "source:client_id"
```

Autenticación HTTPS de ejemplo

GET /api/v1/rest/
HTTPS/1.1
Host: yieldanalytics.xandr.com
Accept: application/xml, application/json
Content-Type: application/json
username: {{username}}
password: {{password}}
source: {{client_id}}

Ejemplo de autenticación POSTMAN

Busque un ejemplo de configuración de encabezado en Postman a continuación:
Nota:
- "Autorización" se establece en "Sin autenticación"; la configuración siguiente se colocará en la pestaña "Encabezados".
- Para obtener un tutorial más detallado sobre el uso de Postman, consulte Uso de Postman con yield analytics API.

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.

Paths

Ejecución del análisis guardado

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

Descripción

Busque un análisis guardado. Estos informes se pueden configurar en la interfaz de usuario de Yield Analytics o a través de yield analytics API y, a continuación, se hace referencia a ellos mediante el identificador de informe.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
PathParameter	savedAnalysisId	savedAnalysisId	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume

application/json
Produce
- application/xml
- application/json
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100' 
-i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 
'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

GET /api/v1/rest/queryengine/analysis/100 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Ejecución del análisis guardado con recuento de filas

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

Descripción

Busque un análisis guardado con un recuento de filas. Estos informes se pueden configurar en la interfaz de usuario de Yield Analytics o a través de yield analytics API y, a continuación, se hace referencia a ellos mediante el identificador de informe y el resultado se puede limitar al número deseado de filas.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
PathParameter	savedAnalysisId	savedAnalysisId	true	string
PathParameter	rowCount	rowCount	true	integer (int32)
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume

application/json
Produce
- application/xml
- application/json
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100/1' -i -H 'Content-Type: application/json' -H 
'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

GET /api/v1/rest/queryengine/analysis/100/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Ejecución del análisis guardado con recuento de filas e inicio de fila

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

Descripción

Busque un análisis guardado con un recuento de filas e inicie la fila. Estos informes se pueden configurar en la interfaz de usuario de Yield Analytics o a través de yield analytics API y, a continuación, se hace referencia a ellos mediante el identificador de informe. El recuento de filas y los parámetros de inicio de fila permiten la paginación a través de las filas del informe.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
PathParameter	savedAnalysisId	savedAnalysisId	true	string
PathParameter	rowCount	rowCount	true	integer (int32)
PathParameter	startRow	startRow	true	integer (int32)
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume

application/json
Produce
- application/xml
- application/json
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100/1/2' -i -H 'Content-Type: application/json' 
-H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

GET /api/v1/rest/queryengine/analysis/100/1/2 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Ejecución del análisis dinámico

POST /api/v1/rest/queryengine/analysisdynamic

Descripción

Ejecutar análisis dinámicos.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	reportDefinition	reportDefinition	true	Report
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' 
-d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/analysisdynamic HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Ejecución del análisis dinámico

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}

Descripción

Ejecutar análisis dinámicos.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	reportDefinition	reportDefinition	true	Report
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume

application/json
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/analysisdynamic HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Ejecución del análisis dinámico con recuento de filas

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}/{rowCount}

Descripción

Ejecute análisis dinámicos con un recuento de filas.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	reportDefinition	reportDefinition	true	Report
PathParameter	rowCount	rowCount	true	integer (int32)
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume

application/json
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/analysisdynamic/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Ejecución del análisis dinámico con recuento de filas e inicio de fila

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}/{rowCount}/{startRow}

Descripción

Ejecute análisis dinámicos con un recuento de filas y un inicio de fila.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	reportDefinition	reportDefinition	true	Report
PathParameter	rowCount	rowCount	true	integer (int32)
PathParameter	startRow	startRow	true	integer (int32)
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume

application/json
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1/2' -i -X POST 
   -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/analysisdynamic/1/2 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Ejecución del análisis dinámico con recuento de filas

POST /api/v1/rest/queryengine/analysisdynamic/{rowCount}

Descripción

Ejecute análisis dinámicos con un recuento de filas.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	reportDefinition	reportDefinition	true	Report
PathParameter	rowCount	rowCount	true	integer (int32)
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/analysisdynamic/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Ejecución del análisis dinámico con recuento de filas e inicio de fila

POST /api/v1/rest/queryengine/analysisdynamic/{rowCount}/{startRow}

Descripción

Ejecute análisis dinámicos con un recuento de filas y un inicio de fila.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	reportDefinition	reportDefinition	true	Report
PathParameter	rowCount	rowCount	true	integer (int32)
PathParameter	startRow	startRow	true	integer (int32)
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1/2' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/analysisdynamic/1/2 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Obtención de un informe de analizador dinámico por definición de informe mediante POST

POST /api/v1/rest/queryengine/analysisdynamicchart

Descripción

Los informes definidos por una definición de informes se pueden recuperar dinámicamente del Analizador de destino.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	reportDefinition	reportDefinition	true	Report
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Obtención de un informe de analizador dinámico por definición de informe mediante GET

GET /api/v1/rest/queryengine/analysisdynamicchart/{reportDefinition}

Descripción

Los informes definidos por una definición de informes se pueden recuperar dinámicamente del Analizador de destino.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	reportDefinition	reportDefinition	true	Report
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar CountResponse
Consume

application/json
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	CountResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamicchart/' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/analysisdynamicchart/ HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

Post de consulta por lotes

POST /api/v1/rest/queryengine/batch

Descripción

La llamada por lotes del servicio del motor de consultas puede ejecutar una secuencia arbitraria de instrucciones SQL y devolver un conjunto de resultados. Se pueden usar para realizar operaciones CRUD o selecciones.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	queryStringRequest	queryStringRequest	true	QueryStringRequest
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar CountResponse
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	CountResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/batch' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d 
'{
  "query" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2010-07-01','2010-07-31') 
   group by consumption_date order by consumption_date asc",
  "batchQueryParams" : [ {
    "first" : "INVENTORY_CLASS",
    "second" : [ "GUARANTEED" ]
  } ]
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/batch HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 268

{
  "query" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2010-07-01','2010-07-31') 
   group by consumption_date order by consumption_date asc",
  "batchQueryParams" : [ {
    "first" : "INVENTORY_CLASS",
    "second" : [ "GUARANTEED" ]
  } ]
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 326

{
  "queryString" : "SELECT * FROM TABLE",
  "batchQueryResults" : [ {
    "batchId" : "1",
    "batchParams" : "sample batch param",
    "resultData" : {
      "row" : [ {
        "columnData" : [ {
          "name" : "sample name",
          "value" : "sample value"
        } ]
      } ]
    },
    "resultCode" : 1
  } ]
}

Obtención de consultas por lotes

GET /api/v1/rest/queryengine/batch/{queries}/{query}

Descripción

La llamada por lotes del servicio del motor de consultas puede ejecutar una secuencia arbitraria de instrucciones SQL y devolver un conjunto de resultados. Se pueden usar para realizar operaciones CRUD o selecciones.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
PathParameter	Consultas	Consultas	true	string
BodyParameter	queryVars	queryVars	false	object
PathParameter	consulta	consulta	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar BatchQueryResponse
Consume

application/json
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	BatchQueryResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/batch/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')
%20group%20by%20consumption_date%20order%20by%20consumption_date%20ascconsumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20
consumption_date%20order%20by%20consumption_date%20asc' -i -H 'Content-Type: application/json;charset=UTF-8' 
-d '"{\"relativeDate\":\"2020-03-19\", \"title\":\"test\"}"'

Solicitud HTTP de ejemplo

GET /api/v1/rest/queryengine/batch/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),
'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20ascconsumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%
20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 55

"{\"relativeDate\":\"2020-03-19\", \"title\":\"test\"}"

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 326

{
  "queryString" : "SELECT * FROM TABLE",
  "batchQueryResults" : [ {
    "batchId" : "1",
    "batchParams" : "sample batch param",
    "resultData" : {
      "row" : [ {
        "columnData" : [ {
          "name" : "sample name",
          "value" : "sample value"
        } ]
      } ]
    },
    "resultCode" : 1
  } ]
}

Instrucción Execute mediante GET

GET /api/v1/rest/queryengine/execute/{statement}

Descripción

Ejecute una instrucción SQL que se pasa a través de la API.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
PathParameter	instrucción	instrucción	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar CountResponse
Consume

application/json
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	CountResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%
20data_source_type%20=%20'ORDER_LINE'' -i -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

GET /api/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%20data_source_type%20=%20'ORDER_LINE' 
HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

Instrucción Execute mediante POST

POST /api/v1/rest/queryengine/execute/{statement}

Descripción

Ejecute una instrucción SQL que se pasa a través de la API.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
PathParameter	instrucción	instrucción	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar CountResponse
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	CountResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20
where%20data_source_type%20=%20'ORDER_LINE'' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%20data_source_type%20=%20'ORDER_LINE' 
HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

Ejecución de una instrucción de consulta SQL por objeto de solicitud

POST /api/v1/rest/queryengine/executerequest

Descripción

Ejecute una instrucción SQL pasando un objeto Query Request.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	statementHolder	statementHolder	true	QueryRequest
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar CountResponse
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	CountResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/executerequest' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "queryRequest" : {
    "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/executerequest HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 194

{
  "queryRequest" : {
    "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

Consulta por instrucción body

POST /api/v1/rest/queryengine/query

Descripción

Pase una instrucción similar a SQL como parte del cuerpo de una publicación.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	consulta	consulta	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/query HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 167

{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Consulta por instrucción mediante GET

GET /api/v1/rest/queryengine/query/{query}

Descripción

Pase una consulta SQL como parámetro de ruta de acceso. Para ejecutar varias instrucciones, las instrucciones deben estar delimitadas por un punto y coma. En el caso de que los datos contengan un punto y coma, utilice la versión POST de esta llamada.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	consulta	consulta	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20
from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc' 
-i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' 
-H 'password: {{password}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

GET /api/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01',
'2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Consulta por instrucción mediante POST

POST /api/v1/rest/queryengine/query/{query}

Descripción

Pase una consulta SQL como parámetro de ruta de acceso. Para ejecutar varias instrucciones, las instrucciones deben estar delimitadas por un punto y coma. En el caso de que los datos contengan un punto y coma, utilice la versión POST de esta llamada.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
PathParameter	consulta	consulta	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by
%20consumption_date%20asc' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),
'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Consulta por solicitud de consulta

POST /api/v1/rest/queryengine/queryrequest/{decode}

Descripción

Pase un objeto Query Request para consultar el motor.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema	Predeterminada
BodyParameter	consulta	consulta	true	QueryRequest
QueryParameter	Decodificar	Decodificar	false	booleano	true
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryrequest/true' -i -X POST -H 
'Content-Type: application/json;charset=UTF-8' -d '{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/queryrequest/true HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 167

{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') group by 
consumption_date order by consumption_date asc"
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Conjunto de consultas mediante GET

GET /api/v1/rest/queryengine/queryset

Descripción

La llamada al conjunto de consultas del servicio del motor de consultas puede ejecutar una secuencia arbitraria de instrucciones SQL y devolver un conjunto de resultados. Se pueden usar para realizar operaciones CRUD o selecciones.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	querySet	querySet	true	QuerySet
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume

application/json
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryset' -i -H 'Content-Type: application/json;
charset=UTF-8' -d '{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}'

Solicitud HTTP de ejemplo

GET /api/v1/rest/queryengine/queryset HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 278

{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Conjunto de consultas mediante POST

POST /api/v1/rest/queryengine/queryset

Descripción

La llamada al conjunto de consultas del servicio del motor de consultas puede ejecutar una secuencia arbitraria de instrucciones SQL y devolver un conjunto de resultados. Se pueden usar para realizar operaciones CRUD o selecciones.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
BodyParameter	querySet	querySet	true	QuerySet
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryResultData
Consume
- application/json
- application/xml
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryResultData

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryset' -i -X POST -H 
'Content-Type: application/json;charset=UTF-8' -d '{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}'

Solicitud HTTP de ejemplo

POST /api/v1/rest/queryengine/queryset HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 278

{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}

Respuesta HTTP de ejemplo

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Los informes definidos y guardados en el analizador de destino se pueden ejecutar como un servicio basado en REST

GET /api/v1/rest/queryengine/xml/{query}

Descripción

Obtenga un informe del analizador guardado por identificador.

Parámetros

Tipo	Nombre	Descripción	Obligatorio	Esquema
PathParameter	consulta	consulta que debe ejecutarse	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar QueryEngineXML
Consume

application/json
Produce
- application/json
- application/xml
Tags

Recurso del motor de consultas

Código HTTP	Description	Esquema
200	Aceptar	QueryEngineXML

Funciones

El motor de consultas admite una gran cantidad de funciones de base de datos genéricas integradas. Las funciones de Yield Analytics también están en vigor para facilitar el trabajo con el modelo de inventario.

Función	Descripción	Ejemplo
ACTIVE_RATE_CARD_PRODUCTS	devuelve todos los identificadores de producto de tarjeta de tasa activa (PID) en el sistema.	EJEMPLO DE PRUEBA
ACTIVE_REPORTING_PRODUCTS	devuelve todos los identificadores de productos de informes activos (PID) del sistema.	EJEMPLO DE PRUEBA
ALL_RATE_CARD_PRODUCTS	devuelve todos los identificadores de productos de tarjeta de tarifa (PID) en el sistema	EJEMPLO DE PRUEBA
ALL_RATE_CARD_PRODUCTS	devuelve todos los identificadores de productos de informes (PID) en el sistema	EJEMPLO DE PRUEBA
PRODUCT_GROUP	groupNames devuelve todos los identificadores de producto del grupo de destino con el nombre especificado.	EJEMPLO DE PRUEBA
PRODUCTS_BY_CHARACTERISTICS	características: por ejemplo, size=120x90, size=460x80, sex=male, behavioral!=political devolver todos los identificadores de producto que coincidan con las características dadas	EJEMPLO DE PRUEBA
PRODUCTS_BY_MATCHPRASE	matchphrases	EJEMPLO DE PRUEBA
PRODUCTS_BY_NAME	names	EJEMPLO DE PRUEBA

Alias

ALIAS_KEY	DATASOURCE_TYPE
ACCIONES	<>ACTION_NAME_TOTAL_ACTIONS_POST_IMPRESSIONS
ACCIONES	<>ACTION_NAME_TOTAL_ACTIONS
ACCIONES	<>ACTION_NAME_ECPA
ANUNCIANTE	ORDER_LINE
AGENCIA	ORDER_LINE
DISPONIBILIDAD	PRODUCTO
AVERAGE_FREQUENCY_DAILY	PRODUCTO
AVERAGE_FREQUENCY_WEEKLY	PRODUCTO
AVERAGE_UNIQUES_DAILY	PRODUCTO
AVERAGE_UNIQUES_WEEKLY	PRODUCTO
BOOKED_CPM	ORDER_LINE
BOOKED_IMPRESSIONS	ORDER_LINE
BOOKED_VALUE	ORDER_LINE
BOOKING_TYPE	OLP_IMPRESSIONS
CAMPAIGN_NAME	ORDER_LINE
CLOSE_DATE	ORDER_LINE
CONSUMED_IMPRESSIONS	OLP_IMPRESSIONS
CONSUMED_IMPRESSIONS_LIFETIME	OLP_IMPRESSIONS
CONSUMED_VALUE	ORDER_LINE
CONSUMPTION_DATE	OLP_IMPRESSIONS
CONSUMPTION_TYPE	OLP_IMPRESSIONS
CONTRACT_TYPE	ORDER_LINE
CONTRACTED_CPD	ORDER_LINE
CONTRACTED_CPD_OLTP	OLTP
CONTRACTED_CPM	ORDER_LINE
CONTRACTED_IMPRESSIONS	ORDER_LINE
CONTRACTED_IMPRESSIONS_CPM_ONLY	ORDER_LINE
CONTRACTED_IMPRESSIONS_CPM_ONLY_OLTP	OLTP
CONTRACTED_IMPRESSIONS_GOAL_BASED_ONLY	ORDER_LINE
CONTRACTED_IMPRESSIONS_LIFETIME	ORDER_LINE
CONTRACTED_IMPRESSIONS_OLTP	OLTP
CONTRACTED_IMPRESSIONS_TOTAL	ORDER_LINE
CONTRACTED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE	ORDER_LINE
CONTRACTED_RATE	ORDER_LINE
CONTRACTED_REVENUE	ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY	ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY_FULL	ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY_OLTP	OLTP
CONTRACTED_REVENUE_CPM_ONLY	ORDER_LINE
CONTRACTED_REVENUE_CPM_ONLY_FULL	ORDER_LINE
CONTRACTED_REVENUE_CPM_ONLY_OLTP	OLTP
CONTRACTED_REVENUE_FULL	ORDER_LINE
CONTRACTED_REVENUE_LIFETIME	ORDER_LINE
CONTRACTED_REVENUE_OLTP	OLTP
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE	ORDER_LINE
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE_FULL	ORDER_LINE
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE_OLTP	OLTP
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE	ORDER_LINE
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP	OLTP
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
CURRENT_PRODUCT_ID	ORDER_LINE
DATA_ELEMENTS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
DAYS_IN_CPD_ONLY	ORDER_LINE
DAYS_IN_CPD_ONLY_OLTP	OLTP
DAYS_TO_DELIVERY	OLP_IMPRESSIONS
DAYS_TO_DELIVERY_CUM	OLP_IMPRESSIONS
DELIVERABLE_GUARANTEED_IMPRESSIONS	ORDER_LINE
DELIVERABLE_IMPRESSIONS	ORDER_LINE
DELIVERABLE_IMPRESSIONS_LIFETIME	ORDER_LINE
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE	OLP_IMPRESSIONS
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP	OLTP
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
DELIVERED_CLICKS	OLP_CLICKS
DELIVERED_CLICKS_LIFETIME	OLP_CLICKS
DIRECT_AVERAGE_FREQUENCY_DAILY	ORDER_LINE
DIRECT_AVERAGE_FREQUENCY_WEEKLY	ORDER_LINE
DIRECT_AVERAGE_UNIQUES_DAILY	ORDER_LINE
DIRECT_AVERAGE_UNIQUES_WEEKLY	ORDER_LINE
DIRECT_LIFETIME_UNIQUES	ORDER_LINE
EARNED_IMPRESSIONS	ORDER_LINE
EARNED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE	ORDER_LINE
EARNED_REVENUE	ORDER_LINE
EARNED_REVENUE_LIFETIME	ORDER_LINE
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE	ORDER_LINE
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP	OLTP
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
FECHA_FINAL	ORDER_LINE
ESTABLISHED_ASP	PRODUCTO
EXTERNAL_ID	ORDER_LINE
PISO	PRODUCTO
FOCUSED_CONSUMED_VALUE	OLP_IMPRESSIONS
FOCUSED_EARNED_IMPRESSIONS	OLP_IMPRESSIONS
FOCUSED_EARNED_REVENUE	OLPEVENT
HARD_CUTOFF	ORDER_LINE
IMPRESSION_CAP_PER_DAY	ORDER_LINE
IMPRESSION_CAPACITY	PRODUCTO
IN_NETWORK	ORDER_LINE
INDUSTRIA	ORDER_LINE
INVENTORY_CLASS	ORDER_LINE
MASTER_ID	ORDER_LINE
MC_TYPE	ORDER_LINE
NETWORK_STATUS	PRODUCTO
ORDEN	ORDER_LINE
ORDER_EXTERNAL_ID	ORDER_LINE
ORDER_LINE	ORDER_LINE
ORDER_LINE_DELIVERY_SCOPE_TARGET	ORDER_LINE
ORDER_LINE_ID	ORDER_LINE
ORDER_LINE_SITE_NAME	ORDER_LINE
ORDER_LINE_SIZE	ORDER_LINE
ORDER_LINE_STATUS	ORDER_LINE
ORDER_LINE_TARGET	ORDER_LINE
ORDER_LINE_TARGET_ATTRIBUTE	ORDER_LINE
ORDER_LINE_TARGET_EXPRESSION	ORDER_LINE
ORDER_LINE_TARGET_EXTERNAL_ID	ORDER_LINE
ORDER_LINE_TARGET_ID	ORDER_LINE
ORDER_NAME	ORDER_LINE
ORDER_STATE	ORDER_LINE
PACKAGE_ID	ORDER_LINE
PARENT_TARGET	PRODUCTO
PRICING_TYPE	ORDER_LINE
PRIORIDAD	ORDER_LINE
PRODUCTO	PRODUCTO
PRODUCTO	RATE_CARD
PRODUCTO	REPORTING_TYPE
PRODUCTO	REVENUE_CAPACITY
PRODUCTO	SELL_STATUS
PRODUCTO	ESTADO
PRODUCTO	TARGET_ATTRIBUTE
PRODUCTO	TARGET_CREATION_DATE
PRODUCTO	TARGET_GROUP
PRODUCTO	TARGET_ID
PRODUCTO	TARGET_OVERLAP
PRODUCTO	TARGET_TYPE
PRODUCTO	UNMET_DEMAND
PRODUCTO	WEIGHTED_RATE_CARD
PRODUCTO	<>ACTION_NAME_TOTAL_ACTIONS_POST_CLICKS
PRODUCT_EXPRESSION PRODUCTO	PRODUCT_EXTERNAL_ID
RANGE_END	ORDER_LINE
RANGE_START	ORDER_LINE
RATE_CARD_REVENUE	ORDER_LINE
RATE_CARD_REVENUE_CPM_ONLY	ORDER_LINE
RATE_CARD_REVENUE_CPM_ONLY_OLTP	OLTP
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE	ORDER_LINE
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE_FULL	OLTP
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE_OLTP	OLTP
SALES_PERSON	ORDER_LINE
SALES_TEAM_MEMBER	ORDER_LINE
SCHEDULED_IMPRESSIONS	ORDER_LINE
SCHEDULED_IMPRESSIONS_LIFETIME	ORDER_LINE
SCHEDULED_IMPRESSIONS_OLTP	OLTP
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE	OLP_IMPRESSIONS
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP	OLTP
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
SOLD_AS_PRODUCT	ORDER_LINE
SOLD_AS_PRODUCT_ID	ORDER_LINE
FECHA_INICIAL	ORDER_LINE
SYSTEM_OF_RECORD	ORDER_LINE
TILE_IDS	ORDER_LINE
TILE_NAMES	ORDER_LINE

Definiciones

AdditionalDimension

Objeto JSON que contiene los resultados del informe AdditionalDimension of Analyzer.

Nombre	Descripción	Obligatorio	Esquema
groupingModifier	Modificador de agrupación de dimensión adicional	true	string
clave	Clave de dimensión adicional	true	string

AdditionalMetric

Objeto JSON que contiene los resultados de AdditionalMetric del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
clave	Clave de dimensión adicional	true	string

AnalyzerReport

Objeto JSON que contiene los resultados de AnalyzerReport.

Nombre	Descripción	Obligatorio	Esquema
additionalDimensions	Colección de dimensiones adicionales	false	Matriz MapOfstringAndAdditionalDimension
additionalMetrics	Colección de métricas adicionales	false	Matriz MapOfstringAndAdditionalMetric
dashboardDateRange	El intervalo de fechas del panel del informe del analizador	false	DateRangeData
dashboardDimension	Dimensión del panel del informe del analizador	false	string
dashboardTableData	Los datos de la tabla de panel del informe del analizador	false	TableState
dateRange	Intervalo de fechas del informe del analizador	false	DateRangeData
dateRangeFilters	Colección de filtros de intervalo de fechas de informe	false	Matriz MapOfstringAndReportDateRangeFilter
dimensionFilters	Colección de filtros de dimensión	false	Matriz MapOfstringAndFilter
includeZeroValues	Campo incluir cero valores del informe del analizador	false	string
keyValueFilters	Colección de filtros de valor de clave de informe	false	Matriz MapOfstringAndReportKeyValueFilter
leftYAxis	Eje Y izquierdo del informe del analizador	true	string
metricFilters	Asignación de nombre a una lista de filtros de métricas	true	Matriz MapOfstringAndMetricFilterEntry
numericRangeFilters	El campo contiene una lista de filtros de intervalo numérico	false	Matriz MapOfstringAndReportNumericRangeFilter
Orderby	El orden por campo del informe del analizador	false	string
Pagesize	Tamaño de página del informe del analizador	false	integer (int32)
rightYAxis	Eje Y derecho del informe del analizador	false	string
selectedTab	Pestaña seleccionada del informe del analizador	false	string
sizeBy	Tamaño por campo del informe del analizador	false	string
sortBy	Ordenación por campo del informe del analizador	false	string
stackBy	La pila por campo del informe del analizador	false	string
stackbyIncrement	Campo pila por incremento del informe del analizador	false	string
tabDateRanges	Asignación de intervalos de fechas de nombre a tabla	true	Matriz MapOfstringAndDateRangeEntry
tablePageSize	Tamaño de página de tabla del informe del analizador	false	integer (int32)
tableState	Estado de la tabla del informe del analizador	false	TableState
pestañas	El campo contiene una lista de pestañas	true	Matriz MapOfstringAndTab
trendPoints	Colección de puntos de tendencia	false	Matriz MapOfstringAndTrendPoint
vista	Vista del informe del analizador	false	string
widgetCacheWarm	Campo intermedio de caché de widgets del informe del analizador	false	string
widgetFilter	Filtro de widget del informe del analizador	false	WidgetFilter
widgetNumericType	El tipo numérico de widget del informe del analizador	false	enumeración (NEGATIVE_ONLY, POSITIVE_ONLY)
widgetView	Vista de widget del informe del analizador	false	string
Xaxis	Eje x del informe del analizador	true	string
xAxisIncrement	Incremento del eje x del informe del analizador	false	string

BatchQueryParams

Objeto JSON que contiene los parámetros de consulta por lotes.

Nombre	Descripción	Obligatorio	Esquema
Primero	Primer campo de los parámetros de consulta por lotes	true	string
Segundo	Colección de segundos campos	true	matriz de cadena

BatchQueryResponse

Objeto JSON que contiene los resultados de una respuesta de consulta por lotes.

Nombre	Descripción	Obligatorio	Esquema
batchQueryResults	Colección de resultados de consultas por lotes	false	Matriz BatchQueryResult
Querystring	Cadena de consulta de la respuesta de consulta por lotes	true	string

BatchQueryResult

Objeto JSON que contiene los resultados de un resultado de consulta por lotes.

Nombre	Descripción	Obligatorio	Esquema
batchId	Identificador de lote del resultado de la consulta por lotes	true	string
batchParams	Los parámetros por lotes del resultado de la consulta por lotes	true	string
resultCode	El código de resultado del resultado de la consulta por lotes	true	integer (int32)
resultData	Los datos de resultado de la consulta del resultado de la consulta por lotes	true	QueryResultData

Column

Nombre	Descripción	Obligatorio	Esquema
name	Nombre del encabezado	false	string
valor	Valor del encabezado	false	string

ColumnData

Objeto JSON que contiene los resultados de los datos de una columna.

Nombre	Descripción	Obligatorio	Esquema
name	Nombre de los datos de columna	true	string
valor	Objeto de valor de los datos de columna	true	string

ColumnFilter

Objeto JSON que contiene los resultados de ColumnFilter del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
campo	Campo del filtro de columna	true	string
Lógica	Lógica del filtro de columna	true	string
operator	Colección de operadores	true	matriz de cadena
valor	Colección de valores	true	matriz de cadena

ColumnSort

Objeto JSON que contiene los resultados de ColumnSort del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
direction	Dirección de la ordenación de columna	true	string
campo	Campo de la ordenación de columna	true	string

CountResponse

Objeto JSON que contiene los resultados de una respuesta de recuento.

Nombre	Descripción	Obligatorio	Esquema
failedStatements	Recuento de instrucciones con errores	false	matriz de cadena
successfulStatements	Recuento de instrucciones correctas	false	matriz de cadena

DateRangeData

Objeto JSON que contiene los resultados de DateRangeData del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
customCalendarId	Identificador de calendario personalizado de los datos del intervalo de fechas	false	string
customPeriod	Campo de período personalizado de THe de los datos del intervalo de fechas	false	booleano
endDate	Fecha de finalización de los datos del intervalo de fechas	false	string
rangeLength	Longitud del intervalo de datos del intervalo de fechas	false	integer (int32)
rangeUnits	Unidades de intervalo de los datos del intervalo de fechas	false	string
startDate	Fecha de inicio de los datos del intervalo de fechas	false	string
trimToRemainderOfCustomPeriod	Recorte al resto del campo de período personalizado de los datos del intervalo de fechas	false	booleano
type	Tipo de los datos del intervalo de fechas	true	string

DateRangeEntry

Objeto JSON que contiene DateRangeEntry.

Nombre	Descripción	Obligatorio	Esquema
dateRange	Campo dateRange de DateRangeEntry	false	DateRangeData
string	Campo de cadena de DateRangeEntry	true	string

Filtro

Objeto JSON que contiene los resultados del filtro del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
name	Nombre del filtro	true	string
operator	Operador del filtro	true	string
valor	Valor del filtro	true	string

Objeto JSON que contiene los resultados del filtro del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
Generado	Cadena de encabezado generada	false	string
consulta	Cadena de consulta de encabezado	false	string

MetricFilterEntry

Objeto JSON que contiene MetricFilterEntry.

Nombre	Descripción	Obligatorio	Esquema
lista	Colección de filtros	false	object
string	Campo de cadena de MetricFilterEntry	true	string

QueryEngineXML

Objeto JSON que contiene el resultado de la consulta.

Nombre	Descripción	Obligatorio	Esquema
encabezado	Encabezado del xml del motor de consulta	true	Header
Resultado	Conjunto de resultados de xml del motor de consulta	true	Resultado

QueryRequest

Objeto JSON que contiene el resultado de la consulta.

Nombre	Descripción	Obligatorio	Esquema
queryRequest		false	QueryRequest
Sql	Entrada sql en el motor de consulta	true	string

QueryResultData

Objeto JSON que contiene los resultados de los datos de resultados de una consulta.

Nombre	Descripción	Obligatorio	Esquema
row	Colección de datos de fila	false	Matriz RowData

RowData

Objeto JSON que contiene los resultados de los datos de una fila.

Nombre	Descripción	Obligatorio	Esquema
columnData	Colección de datos de columna	true	Matriz ColumnData

QuerySet

Objeto JSON que contiene los resultados de los datos de resultados de una consulta.

Nombre	Descripción	Obligatorio	Esquema
querySet		false	QuerySet
relativeDate	Datos relativos del conjunto de consultas	true	string
Solicitudes	Colección de solicitudes de consulta	false	Matriz QueryRequest
title	Título del conjunto de consultas	true	string

QueryStringRequest

Objeto JSON que contiene la solicitud de cadena de consulta.

Nombre	Descripción	Obligatorio	Esquema
batchQueryParams	Colección de parámetros de consulta por lotes	true	Matriz BatchQueryParams
consulta	Campo de consulta de la solicitud de cadena de consulta	true	string

Informe

Objeto JSON que contiene la solicitud de cadena de consulta.

Nombre	Descripción	Obligatorio	Esquema
Informe		false	AnalyzerReport

ReportDateRangeFilter

Objeto JSON que contiene los resultados de ReportDateRangeFilter del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
dataSetKey	Clave del conjunto de datos del filtro de intervalo de fechas del informe	true	string
dateRange	Datos del intervalo de fechas del filtro de intervalo de fechas del informe	true	DateRangeData
clave	Clave del filtro de intervalo de fechas del informe	true	string

ReportKeyValueFilter

Objeto JSON que contiene los resultados de ReportKeyValueFilter del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
dataSetKey	Clave del conjunto de datos del filtro de valor de clave de informe	true	string
clave	Clave del filtro de valor de clave de informe	true	string
name	Nombre del filtro de valor de clave de informe	true	string
operator	Operador del filtro de valor de clave de informe	true	string
valor	Valor del filtro de valor de clave de informe	true	string
valueMatchTypeValue	Valor del tipo de coincidencia de valor del filtro de valor de clave de informe	true	string

ReportNumericRangeFilter

Objeto JSON que contiene los resultados de ReportNumericRangeFilter del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
dataSetKey	Clave del conjunto de datos del filtro de intervalo numérico del informe	true	string
highValue	Valor alto del filtro de intervalo numérico del informe	true	number (double)
id	Identificador del filtro de intervalo numérico del informe	true	integer (int32)
clave	Clave del filtro de intervalo numérico del informe	true	string
lowValue	Valor bajo del filtro de intervalo numérico del informe	true	number (double)

Resultado

Objeto JSON que contiene los resultados de ReportNumericRangeFilter del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
rows	Colección de filas	false	Matriz de filas

Fila

Nombre	Descripción	Obligatorio	Esquema
columns	Colección de columnas	false	Matriz de columnas

Column

Nombre	Descripción	Obligatorio	Esquema
name	Nombre del encabezado	false	string
valor	Valor del encabezado	false	string

RowData

Objeto JSON que contiene los resultados de los datos de una fila.

Nombre	Descripción	Obligatorio	Esquema
columnData	Colección de datos de columna	true	Matriz ColumnData

Tab

Objeto JSON que contiene los resultados de La pestaña del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
displayName	Nombre para mostrar de la pestaña	true	string
id	Identificador de la pestaña	true	string
name	Nombre de la pestaña	true	string
Seleccionado	Campo seleccionado de la pestaña	true	booleano

TableState

Objeto JSON que contiene los resultados de TableState del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
ascending	Campo ascendente del estado de la tabla	true	booleano
columnFilters	Colección de filtros de columna	false	Matriz ColumnFilter
columnOrdering	Colección de ordenación de columnas	true	object
columnSorts	Una colección de ordenaciones de columnas	false	Matriz ColumnSort
clave	Clave del estado de la tabla	false	string
sortBy	Ordenación por campo del estado de la tabla	true	string

TrendPoint

Objeto JSON que contiene los resultados del informe TrendPoint of Analyzer.

Nombre	Descripción	Obligatorio	Esquema
clave	Clave del punto de tendencia	true	string

Objeto JSON que contiene los resultados de WidgetFilter del informe del analizador.

Nombre	Descripción	Obligatorio	Esquema
defaultSelections	Selecciones predeterminadas del filtro de widget	true	string
reportParamType	Tipo de parámetro de informe del filtro de widget	true	string
selectionLabels	Las etiquetas de selección del filtro de widget	true	string
selectionValues	Valores de selección del filtro de widget	true	string

Yield Analytics API

Compartir a través de

Servicio del motor de consultas

Información general

Tipos de contenido

Códigos de estado y comprobación de errores

Seguridad

Confidencialidad

Paths

Ejecución del análisis guardado

Ejecución del análisis guardado con recuento de filas

Ejecución del análisis guardado con recuento de filas e inicio de fila

Ejecución del análisis dinámico

Ejecución del análisis dinámico

Ejecución del análisis dinámico con recuento de filas

Ejecución del análisis dinámico con recuento de filas e inicio de fila

Ejecución del análisis dinámico con recuento de filas

Ejecución del análisis dinámico con recuento de filas e inicio de fila

Obtención de un informe de analizador dinámico por definición de informe mediante POST

Obtención de un informe de analizador dinámico por definición de informe mediante GET

Post de consulta por lotes

Obtención de consultas por lotes

Instrucción Execute mediante GET

Instrucción Execute mediante POST

Ejecución de una instrucción de consulta SQL por objeto de solicitud

Consulta por instrucción body

Consulta por instrucción mediante GET

Consulta por instrucción mediante POST

Consulta por solicitud de consulta

Conjunto de consultas mediante GET

Conjunto de consultas mediante POST

Los informes definidos y guardados en el analizador de destino se pueden ejecutar como un servicio basado en REST

Funciones

Alias

Definiciones

AdditionalDimension

AdditionalMetric

AnalyzerReport

BatchQueryParams

BatchQueryResponse

BatchQueryResult

Column

ColumnData

ColumnFilter

ColumnSort

CountResponse

DateRangeData

DateRangeEntry

Filtro

Encabezado

MetricFilterEntry

QueryEngineXML

QueryRequest

QueryResultData

RowData

QuerySet

QueryStringRequest

Informe

ReportDateRangeFilter

ReportKeyValueFilter

ReportNumericRangeFilter

Resultado

Fila

Column

RowData

Tab

TableState

TrendPoint

WidgetFilter

Tema relacionado

Recursos adicionales