サブスクリプションの分析情報をすべて取得する

[アーティクル]
09/22/2023

適用対象: パートナーセンター | 21Vianet が運営するパートナーセンター | Microsoft Cloud for US Government のパートナーセンター

この記事では、顧客のすべてのサブスクリプション分析情報を取得する方法について説明します。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、ユーザー資格情報のみを使用した認証がサポートされます。

REST 要求

要求の構文

認証方法	要求 URI
GET	{baseURL}/partner/v1/analytics/subscriptions HTTP/1.1

URI パラメーター

次の表に、省略可能なパラメーターとその説明を示します。

パラメーター	Type	説明
上位	int	要求で返すデータの行数です。値が指定されていない場合、最大値と既定値は `10000`. クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。
skip	int	クエリでスキップする行数です。大きなデータセットを操作するには、このパラメーターを使用します。たとえば、 `top=10000skip=0`最初の 10,000 行のデータを取得し`skip=10000`、`top=10000`次の 10,000 行のデータを取得します。
filter	string	応答内の行をフィルター処理する 1 つまたは複数のステートメントです。各フィルターステートメントには、応答本文のフィールド名と、演算子 (または特定のフィールド) に`eq``ne`関連付けられている値が`contains`含まれています。ステートメントは、 `and` または `or`. filter パラメーターでは、文字列値を単一引用符で囲む必要があります。フィルター処理できるフィールドの一覧と、それらのフィールドでサポートされる演算子については、次のセクションを参照してください。
aggregationLevel	string	集計データを取得する時間範囲を指定します。次のいずれかの文字列を指定できます。day、week、または month。値が指定されていない場合、既定値は dateRange です。このパラメーターは、日付フィールドが groupBy パラメーターの一部として渡される場合にのみ適用されます。
Groupby	string	指定したフィールドのみにデータ集計を適用するステートメントです。

要求ヘッダー

詳細については、「パートナーセンター REST ヘッダー」を参照してください。

リクエストの本文

ありません。

要求の例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0

REST 応答

成功した場合、応答本文にはサブスクリプション リソースのコレクションが含まれます。

応答の成功とエラーのコード

各応答には、成功または失敗と追加のデバッグ情報を示す HTTP 状態コードが付属しています。ネットワークトレースツールを使用して、このコード、エラーの種類、その他のパラメーターを読み取ります。完全な一覧については、エラーコードに関するページを参照してください。

応答の例

{
    "customerTenantId": "76906668-27FC-4F5B-A35C-75A9823E13AF",
    "customerName": "TESTORG65656565",
    "customerMarket": "US",
    "id": "4BF546B2-8998-4838-BEE2-5F1BBE65A04F",
    "status": "ACTIVE",
    "productName": "OFFICE 365 BUSINESS PREMIUM",
    "subscriptionType": "Office",
    "autoRenewEnabled": true,
    "partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
    "friendlyName": "FULL OFFICE SUITE",
    "partnerName": "Partner Name",
    "providerName": "Provider Name",
    "creationDate": "2016-02-04T19:29:38.037",
   "effectiveStartDate": "2016-02-04T00:00:00",
    "commitmentEndDate": "2019-02-10T00:00:00",
    "currentStateEndDate": "2019-02-10T00:00:00",
    "trialToPaidConversionDate": null,
    "trialStartDate": null,
    "trialEndDate": null,
    "lastUsageDate": null,
    "deprovisionedDate": null,
    "lastRenewalDate": "2018-02-10T02:39:57.729",
    "licenseCount": 2,
    "churnRisk": "High",
    "billingCycleName": "MONTHLY"

}

Share via