レポート クエリの試行 API

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

重要

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

要求の構文

認証方法	要求 URI
GET	https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledQueries/testQueryResult?<exportQuery={querytext}\|queryId={queryId}>

要求ヘッダー

Header	型	説明
承認	string	必須。 フォーム内の Microsoft Entra アクセス トークン Bearer <token>
Content-Type	string	Application/JSON

パス パラメーター

なし

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

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

要求ペイロード

なし

要求用語集

なし

回答

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

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

応答ペイロードの例:

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

応答用語集

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

パラメーター	説明
TotalCount	Value 配列内のデータセットの数
メッセージ	API の実行からのステータス メッセージ
StatusCode	結果コード。 指定できる値は、200、400、401、403、500 です。