レポート クエリの試行 API

この API は、レポート クエリ ステートメントを実行します。 この API は、パートナーがデータが期待どおりかどうかを確認するために使用できる100レコードのみを返します。

重要

この API のクエリ実行タイムアウトは 100 秒です。 API の処理時間が 100 秒を超えていることがわかった場合は、クエリの構文が正しい可能性が高く、そうでない場合は 200 以外のエラー コードを受け取っている可能性があります。 クエリ構文が正しい場合は、実際のレポート生成が成功します。

要求の構文

Method 要求 URI
GET https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledQueries/testQueryResult?<exportQuery={query text}|queryId={queryId}>

要求ヘッダー

ヘッダー Type 説明
承認 string 必須。 フォーム内の Azure Active Directory (AAD) アクセストークンBearer <token>
Content-Type string Application/JSON

パス パラメーター

なし

Query parameter (クエリ パラメーター)

パラメーター名 Type 必須 説明
exportQuery string いいえ 実行する必要があるレポート クエリの文字列
queryId string いいえ 有効な既存のクエリ ID。 ExportQuery パラメーターで指定されたクエリ文字列と相互に排他的
startTime string いいえ データを必要とする開始時刻。 クエリで指定された timespan をオーバーライドします
endTime string いいえ データが必要になるまでの終了時間。 クエリで指定された timespan をオーバーライドします

要求ペイロード

なし

用語集

None

応答

応答ペイロードは、次のように構成されます。

応答コード: 200、400、401、403、404、500

応答ペイロードの例:

Top 100 rows of query execution 
{ 
  "Value": [ 
    { 
    } 
  ], 
  "TotalCount": 0, 
  "Message": "string", 
  "StatusCode": 0, 
} 

用語集

次の表に、応答の主な要素を定義します。

パラメーター 説明
TotalCount Value 配列内のデータセットの数
Message API の実行からのステータス メッセージ
StatusCode 結果コード。 200、400、401、403、500 の値になる可能性があります