Bewerken

Share via

Query engine service

Saved analysis execution

Overview

You can use the Query Engine service to run pre-defined saved analyses by their identifier. The service doesn't support dynamic SQL execution, batch query execution, or arbitrary statement execution.

Content types

The Service REST API is currently designed to support the following content type:

  • JSON - using Content-type: application/json

Selecting the desired content type is a choice the API developer should make on a case by case basis. API functionality is symmetrical across content types. API developers may specify the desired content type in the HTTP GET or POST method parameters or via their AJAX or HTTP client library.

Error checking and status codes

API developers should check the HTTP response codes returned from the service REST API to detect errors propagated from API calls. Successful calls to the service will result in 200 range response codes. 400 and 500 range http responses denote errors. The specific response codes and text will likely undergo change during BETA development of the API, however, the ranges will not.

Security

The service API exposes application data in a secure manner. Use of API functionality is restricted to authenticated users and is exposed over secure transport protocols. Access to the API must take place within the following context:

Authentication

For more information on authentication, see Yield Analytics API - Authentication Process.

Confidentiality

Confidentiality is maintained by using Secure Socket Layer based communication to interact with the Yield Analytics API. API developers should prefer use of HTTPS over HTTP insecure communication whenever possible. Consult your HTTP Client library on how to enable HTTP over SSL when developing outside of a web browser context.

Host

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

Paths

Execute saved analysis

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

  • Description

    Look up a saved analysis using its report ID.

  • Parameters

    Type Name Description Required Schema
    PathParameter savedAnalysisId Identifier of the saved analysis true string

  • Example cURL request

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

  • Example HTTP request

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

  • Example HTTP response

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

Execute saved analysis with custom date range

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

Look up a saved analysis using a custom date range. The provided start and end dates override the date configuration stored with the report.

  • Parameters

    Type Name Description Required Schema
    PathParameter savedAnalysisId Identifier of the saved analysis true string
    PathParameter startDate The start date of the requested data range (YYYY-MM-DD) true string
    PathParameter endDate The end date of the requested data range (YYYY-MM-DD) true string

  • Example cURL request

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

  • Example HTTP request

    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

  • Example HTTP response

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

Unsupported functionality

The following Query Engine capabilities are not supported:

  • Execute dynamic analysis
  • Batch query execution
  • Direct SQL statement execution
  • Arbitrary query submission

Note

The Query Engine service is restricted to execution of saved analyses only.

Product listing functionality is available via the GraphQL API. Use GraphQL to retrieve a list of products and access product-level metadata using structured queries and filters. Refer to the GraphQL API documentation for supported queries and schema details.

  • Last updated on