紹介の分析情報をすべて取得する

[アーティクル]
03/08/2023

適用対象: パートナーセンター | Microsoft Cloud for US Government のパートナーセンター

顧客のすべての紹介分析情報を取得する方法。

前提条件

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

REST 要求

要求の構文

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

URI パラメーター

パラメーター	Type	説明
filter	string	フィルター条件に一致するデータを返します。例： `.../referrals?filter=field eq 'value'`
groupby	string	使用条件と日付の両方をサポートします。バケットの数を制限する短絡ロジック。例： `.../referrals?groupby=termField1,dateField1,termField2`
aggregationLevel	string	aggregationLevel パラメーターには groupby が必要です。 aggregationLevel パラメーターは、groupby に存在するすべての日付フィールドに適用されます。例： `.../referrals?groupby=termField1,dateField1,termField2&aggregationLevel=day`
top	string	ページの制限は 10000 です。 10000 未満の値を受け取ります。例： `.../referrals?top=100`
skip	string	スキップする行数。例： `.../referrals?top=100&skip=100`

要求ヘッダー

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

[要求本文]

なし。

要求の例

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

REST 応答

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

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

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

応答の例

{
  "id": "112310",
  "status": "Accepted",
  "customerMarket": "US",
  "customerName": "Best Customer Ever",
  "customerOrgSize": "10to50employees",
  "acceptedDate": "2018-02-07T23:43:19",
  "acknowledgedDate": "2018-02-07T23:40:50",
  "archivedDate": null,
  "declinedDate": null,
  "expiredDate": null,
  "lostDate": null,
  "missedDate": null,
  "createdDate": "2018-02-04T23:08:59",
  "skippedDate": null,
  "wonDate": null,
  "partnerMarket": "US"
}