取得依日期或條款分組的訂用帳戶分析

文章
06/19/2023

適用于：合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |適用于 Microsoft Cloud for US Government 的合作夥伴中心

如何取得依日期或條款分組之客戶的訂用帳戶分析資訊。

必要條件

認證，如合作夥伴中心驗證所述。此案例僅支援使用使用者認證進行驗證。

REST 要求

要求的語法

方法	要求 URI
GET	{baseURL}/partner/v1/analytics/subscriptions？groupby={groupby_queries}

URI 參數

使用下列必要路徑參數來識別您的組織，並將結果分組。

名稱	類型	必要	描述
groupby_queries	字串和 dateTime 的配對	Yes	篩選結果的字詞和日期。

GroupBy 語法

依參數的群組必須組成一系列逗號分隔的域值。

未編碼的範例如下所示：

?groupby=termField1,dateField1,termField2

下表顯示群組依據的支援欄位清單。

欄位	類型	描述
customerTenantId	string	識別客戶租使用者的 GUID 格式字串。
customerName	string	客戶的名稱。
customerMarket	string	客戶執行業務的國家/地區。
id	string	用來識別訂用帳戶的 GUID 格式字串。
status	字串	訂用帳戶狀態。支援的值包括：「ACTIVE」、「SUSPENDED」或「DEPROVISIONED」。
productName	string	產品的名稱。
subscriptionType	string	訂閱類型。注意：此欄位區分大小寫。支援的值包括：「Office」、「Azure」、「Microsoft365」、「Dynamics」、「EMS」。
autoRenewEnabled	Boolean	值，指出訂閱是否會自動更新。
partnerId	string	PartnerID。對於直接轉銷商，此參數會是合作夥伴的 PartnerID。如果是間接轉銷商，此參數將是間接轉銷商的 PartnerID。
friendlyName	字串	訂閱的名稱。
partnerName	string	購買訂用帳戶的合作夥伴名稱
providerName	string	當訂用帳戶交易是間接轉銷商時，提供者名稱是購買訂閱的間接提供者。
creationDate	UTC 日期時間格式的字串	建立訂閱的日期。
effectiveStartDate	UTC 日期時間格式的字串	訂閱開始的日期。
commitmentEndDate	UTC 日期時間格式的字串	訂閱結束的日期。
currentStateEndDate	UTC 日期時間格式的字串	訂閱目前狀態將會變更的日期。
trialToPaidConversionDate	UTC 日期時間格式的字串	訂閱從試用版轉換為付費的日期。預設值為 null。
trialStartDate	UTC 日期時間格式的字串	訂閱的試用期間開始的日期。預設值為 null。
lastUsageDate	UTC 日期時間格式的字串	上次使用訂閱的日期。預設值為 null。
deprovisionedDate	UTC 日期時間格式的字串	取消布建訂閱的日期。預設值為 null。
lastRenewalDate	UTC 日期時間格式的字串	訂閱上次更新的日期。預設值為 null。

篩選欄位

下表列出選擇性篩選欄位及其描述：

欄位	類型	描述
top	int	在要求中傳回的資料列數目。如果未指定值，最大值和預設值為 10000。如果查詢中有更多資料列，回應主體將會包含您可以用來要求下一頁資料的下一頁連結。
skip	int	在查詢中要略過的資料列數目。使用此參數來瀏覽大型資料集。例如，top=10000 且 skip=0 會擷取前 10000 個數據列，top=10000，skip=10000 擷取接下來 10000 個數據列。
filter	string	一或多個篩選回應中資料列的陳述式。每個篩選語句都包含回應本文中的功能變數名稱，以及與、 `ne` 或特定欄位 `contains` 相關聯的 `eq` 值運算子。語句可以使用或 `or` 結合 `and` 。篩選參數中的字串值必須由單引號括住。如需可篩選的欄位清單，以及這些欄位支援的運算子，請參閱下一節。
aggregationLevel	string	指定要擷取彙總資料的時間範圍。可以是下列其中一個字串：day、week 或 month。如果未指定值，則預設值為 dateRange。注意：只有當日期欄位作為 groupBy 參數的一部分傳遞時，才會套用此參數。
groupBy	string	將資料彙總僅套用至指定欄位的陳述式。

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。

要求本文

無。

要求範例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0

REST 回應

如果成功，回應本文會包含依指定字詞和日期分組的訂用帳戶資源集合。

回應成功和錯誤碼

每個回應都隨附 HTTP 狀態碼，會指出成功與否以及其他的偵錯資訊。請使用網路追蹤工具來讀取此錯誤碼、錯誤類型和其他參數。如需完整清單，請參閱錯誤碼。

回應範例

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd
{
  "Value": [
    {
      "subscriptionType": "Azure",
      "subscriptionCount": "63",
      "licenseCount": "0"
    },
    {
      "subscriptionType": "Dynamics",
      "subscriptionCount": "62",
      "licenseCount": "405"
    },
    {
      "subscriptionType": "EMS",
      "subscriptionCount": "39",
      "licenseCount": "193"
    },
    {
      "subscriptionType": "M365",
      "subscriptionCount": "2",
      "licenseCount": "5"
    },
    {
      "subscriptionType": "Office",
      "subscriptionCount": "906",
      "licenseCount": "7485"
    },
    {
      "subscriptionType": "UNKNOWN",
      "subscriptionCount": "104",
      "licenseCount": "439"
    },
    {
      "subscriptionType": "Windows",
      "subscriptionCount": "2",
      "licenseCount": "2"
    }
  ],
  "@nextLink": null,
  "TotalCount": 7
}

另請參閱

合作夥伴中心分析 - 資源

分享方式：