取得商業市集的報表查詢 API

取得報表查詢 API 會取得可用於報表的所有查詢。 根據預設，它會取得所有系統和使用者定義查詢。

要求語法

方法	要求 URI
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

要求標頭

頁首	型別	說明
授權	字串	必要。 表單中的Microsoft Entra 存取令牌 Bearer <token>
內容-類型	字串	Application/JSON

路徑參數

無

查詢參數

參數名稱	類型	必要項目	說明
queryId	字串	No	篩選以取得自變數中指定標識碼的查詢詳細數據
queryName	字串	No	篩選以取得自變數中指定名稱的查詢詳細數據
IncludeSystemQueries	boolean	No	在回應中包含預先定義的系統查詢。 預設值為 True。
IncludeOnlySystemQueries	boolean	No	在回應中只包含系統查詢。 預設值為 False

要求承載

無

詞彙

無

回應

響應承載的結構如下：

回應碼：200、400、401、403、404、500

響應承載：

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

詞彙

下表描述回應中專案的主要定義。

參數	說明
QueryId	查詢的唯一 UUID
Name	在建立查詢時提供給查詢的名稱
Description	建立查詢期間提供的描述
Query	報表查詢字串
Type	針對使用者建立的查詢和system預先定義的系統查詢，設定為userDefined
User	建立查詢的使用者標識碼
CreatedTime	建立查詢的時間
TotalCount	Value 陣列中的數據集數目
StatusCode	結果碼。 可能的值為 200、400、401、403、500