次の方法で共有

クエリ エンジン サービス

保存された分析の実行

概要

クエリ エンジン サービスを使用して、事前に定義された保存された分析を識別子によって実行できます。 サービスは、動的 SQL 実行、バッチ クエリ実行、または任意のステートメント実行をサポートしていません。

コンテンツ タイプ

Service REST API は現在、次のコンテンツ タイプをサポートするように設計されています。

  • JSON - using Content-type: application/json

目的のコンテンツ タイプを選択することは、API 開発者がケースバイケースで行う必要がある選択です。 API 機能は、コンテンツ タイプ間で対称的です。 API 開発者は、HTTP GET または POST メソッド パラメーターで、または AJAX または HTTP クライアント ライブラリを使用して、目的のコンテンツ タイプを指定できます。

エラー チェックと状態コード

API 開発者は、サービス REST API から返される HTTP 応答コードをチェックして、API 呼び出しから伝達されたエラーを検出する必要があります。 サービスの呼び出しが成功すると、200 個の範囲応答コードが生成されます。 400 および 500 の範囲の http 応答はエラーを示します。 特定の応答コードとテキストは、API の BETA 開発中に変更される可能性がありますが、範囲は変更されません。

セキュリティ

サービス API は、セキュリティで保護された方法でアプリケーション データを公開します。 API 機能の使用は、認証されたユーザーに制限され、セキュリティで保護されたトランスポート プロトコル経由で公開されます。 API へのアクセスは、次のコンテキスト内で行う必要があります。

認証

認証の詳細については、「 Yield Analytics API - 認証プロセス」を参照してください。

機密性

機密性は、Secure Socket Layer ベースの通信を使用して Yield Analytics API と対話することで維持されます。 API 開発者は、可能な限り HTTP セキュリティで保護されていない通信よりも HTTPS の使用を好む必要があります。 Web ブラウザー コンテキストの外部で開発するときに、SSL 経由で HTTP を有効にする方法については、HTTP クライアント ライブラリを参照してください。

ホスト

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

Paths

保存された分析の実行

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

  • 説明

    レポート ID を使用して保存された分析を検索します。

  • Parameters

    種類 名前 説明 必須 Schema
    PathParameter savedAnalysisId 保存された分析の識別子 true string

  • cURL要求の例

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

  • HTTP 要求の例

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

  • HTTP 応答の例

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

カスタム日付範囲を使用して保存された分析を実行する

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

カスタム日付範囲を使用して保存された分析を検索します。 指定された開始日と終了日は、レポートに格納されている日付構成よりも優先されます。

  • Parameters

    種類 名前 説明 必須 Schema
    PathParameter savedAnalysisId 保存された分析の識別子 true string
    PathParameter startDate 要求されたデータ範囲の開始日 (YYYY-MM-DD) true string
    PathParameter endDate 要求されたデータ範囲の終了日 (YYYY-MM-DD) true string

  • cURL要求の例

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

  • HTTP 要求の例

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

  • HTTP 応答の例

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

サポートされていない機能

次のクエリ エンジン機能はサポートされていません。

  • 動的分析の実行
  • バッチ クエリの実行
  • 直接 SQL ステートメントの実行
  • 任意のクエリの送信

注:

クエリ エンジン サービスは、保存された分析の実行のみに制限されます。

製品一覧機能は、GraphQL API を使用して使用できます。 GraphQLを使用して製品の一覧を取得し、構造化されたクエリとフィルターを使用して製品レベルのメタデータにアクセスします。 サポートされているクエリとスキーマの詳細については、GraphQL API のドキュメントを参照してください。

  • Last updated on