Pobieranie wszystkich informacji analitycznych dotyczących subskrypcji
Dotyczy: Centrum partnerskie | Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA
W tym artykule opisano sposób uzyskiwania wszystkich informacji analitycznych dotyczących subskrypcji dla klientów.
Wymagania wstępne
- Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie tylko przy użyciu poświadczeń użytkownika.
Żądanie REST
Składnia żądania
| Metoda | Identyfikator URI żądania |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions HTTP/1.1 |
Parametry identyfikatora URI
W poniższej tabeli wymieniono opcjonalne parametry i ich opisy:
| Parametr | Type | Opis |
|---|---|---|
| top | int | Liczba wierszy danych do zwrócenia w żądaniu. Jeśli wartość nie jest określona, wartość maksymalna i wartość domyślna to 10000. Jeśli w zapytaniu znajduje się więcej wierszy, treść odpowiedzi zawiera następny link, którego można użyć do żądania następnej strony danych. |
| skip | int | Liczba wierszy do pominięcia w zapytaniu. Użyj tego parametru, aby stronicować za pośrednictwem dużych zestawów danych. Na przykład top=10000 i skip=0 pobiera pierwsze 10 000 wierszy danych top=10000 i skip=10000 pobiera kolejne 10 000 wierszy danych. |
| filtr | string | Co najmniej jedna instrukcja, która filtruje wiersze w odpowiedzi. Każda instrukcja filtru zawiera nazwę pola z treści odpowiedzi i wartość skojarzona z operatorem eq, nelub dla niektórych pól contains . Instrukcje można łączyć przy użyciu polecenia and lub or. Wartości ciągu muszą być otoczone pojedynczymi cudzysłowymi w parametrze filtru. Zapoznaj się z poniższą sekcją, aby zapoznać się z listą pól, które można filtrować, oraz operatorami obsługiwanymi w tych polach. |
| aggregationLevel | string | Określa zakres czasu, dla którego mają być pobierane agregowane dane. Może być jednym z następujących ciągów: dzień, tydzień lub miesiąc. Jeśli wartość nie jest określona, wartość domyślna to dateRange. Ten parametr ma zastosowanie tylko wtedy, gdy pole daty jest przekazywane jako część parametru groupBy . |
| Groupby | string | Instrukcja, która stosuje agregację danych tylko do określonych pól. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.
Treść żądania
Brak.
Przykład żądania
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0
Odpowiedź REST
W przypadku powodzenia treść odpowiedzi zawiera kolekcję zasobów subskrypcji.
Kody powodzenia i błędów odpowiedzi
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i dodatkowe informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów.
Przykład odpowiedzi
{
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"customerName": "TESTORG65656565",
"customerMarket": "US",
"id": "4BF546B2-8998-4838-BEE2-5F1BBE65A04F",
"status": "ACTIVE",
"productName": "OFFICE 365 BUSINESS PREMIUM",
"subscriptionType": "Office",
"autoRenewEnabled": true,
"partnerId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"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"
}