Získání všech analytických informací o předplatných
Platí pro: Partnerské centrum | Partnerské centrum provozované společností 21Vianet | Partnerské centrum pro Microsoft Cloud pro státní správu USA
Tento článek popisuje, jak získat všechny analytické informace o předplatném pro vaše zákazníky.
Požadavky
- Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje ověřování pouze s přihlašovacími údaji uživatele.
Požadavek REST
Syntaxe požadavku
Metoda | Identifikátor URI žádosti |
---|---|
GET | {baseURL}/partner/v1/analytics/subscriptions HTTP/1.1 |
Parametry identifikátoru URI
Následující tabulka uvádí volitelné parametry a jejich popisy:
Parametr | Typ | Popis |
---|---|---|
top | int | Počet řádků dat, které se mají v požadavku vrátit. Pokud tato hodnota není zadaná, maximální hodnota a výchozí hodnota jsou 10000 . Pokud dotaz obsahuje více řádků, text odpovědi obsahuje další odkaz, který můžete použít k vyžádání další stránky dat. |
skip | int | Počet řádků, které se mají v dotazu přeskočit. Pomocí tohoto parametru můžete procházet velké datové sady. Například top=10000 načte skip=0 prvních 10 000 řádků dat top=10000 a skip=10000 načte dalších 10 000 řádků dat. |
filter | řetězec | Jeden nebo více příkazů, které filtrují řádky v odpovědi. Každý příkaz filtru obsahuje název pole z textu odpovědi a hodnotu přidruženou k operátoru eq contains , ne nebo pro určitá pole. Příkazy lze kombinovat pomocí and nebo or . Řetězcové hodnoty musí být v parametru filtru ohraničené jednoduchými uvozovkami. V následující části najdete seznam polí, která se dají filtrovat, a operátory, které jsou s těmito poli podporované. |
aggregationLevel | řetězec | Určuje časový rozsah, pro který se mají načítat agregovaná data. Může to být jeden z následujících řetězců: den, týden nebo měsíc. Pokud tato hodnota není zadaná, výchozí hodnota je dateRange. Tento parametr platí pouze v případě, že je pole data předáno jako součást parametru groupBy . |
Groupby | řetězec | Příkaz, který použije agregaci dat pouze na zadaná pole. |
Záhlaví žádosti
Další informace najdete v tématu Hlavičky REST Partnerského centra.
Text požadavku
Žádné
Příklad požadavku
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0
Odpověď REST
V případě úspěchu text odpovědi obsahuje kolekci prostředků předplatného.
Kódy úspěšnosti a chyb odpovědi
Každá odpověď obsahuje stavový kód HTTP, který indikuje úspěch nebo selhání a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb.
Příklad odpovědi
{
"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"
}