Kommentar
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Gäller för: Partnercenter | Partnercenter som drivs av 21Vianet | Partnercenter för Microsoft Cloud for US Government
Så här hämtar du information om prenumerationsanalys för dina kunder grupperade efter datum eller villkor.
Förutsättningar
- Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder endast autentisering med användarautentiseringsuppgifter.
REST-begäran
Begärandesyntax
| Metod | URI för förfrågan |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries} |
URI-parametrar
Använd följande obligatoriska sökvägsparametrar för att identifiera din organisation och gruppera resultaten.
| Namn | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
| groupby_queries | par med strängar och dateTime | Yes | Villkoren och datumen för att filtrera resultatet. |
GroupBy-syntax
Gruppen efter parameter måste bestå av en serie kommaavgränsade fältvärden.
Ett okodat exempel ser ut så här:
?groupby=termField1,dateField1,termField2
I följande tabell visas en lista över fält som stöds för gruppera efter.
| Fält | Typ | Description |
|---|---|---|
| customerTenantId | sträng | En GUID-formaterad sträng som identifierar kundens klientorganisation. |
| customerName | sträng | Namnet på kunden. |
| customerMarket | sträng | Det land/den region som kunden gör affärer i. |
| id | sträng | En GUID-formaterad sträng som identifierar prenumerationen. |
| status | sträng | Prenumerationsstatus. Värden som stöds är: "ACTIVE", "SUSPENDED" eller "DEPROVISIONED". |
| Productname | sträng | Namnet på produkten. |
| subscriptionType | sträng | Prenumerationstypen. Obs! Det här fältet är skiftlägeskänsligt. Värden som stöds är: "Office", "Azure", "Microsoft365", "Dynamics", "EMS". |
| autoRenewEnabled | Boolesk | Ett värde som anger om prenumerationen förnyas automatiskt. |
| partnerId | sträng | The PartnerID. För en direkt återförsäljare blir den här parametern PartnerID för partnern. För en indirekt återförsäljare blir den här parametern PartnerID för den indirekta återförsäljaren. |
| friendlyName | sträng | Namnet på prenumerationen. |
| partnerName | sträng | Namnet på partnern som prenumerationen köptes för |
| providerName | sträng | När prenumerationstransaktionen gäller för den indirekta återförsäljaren är providernamnet den indirekta leverantör som köpte prenumerationen. |
| creationDate | sträng i UTC-datumtidsformat | Det datum då prenumerationen skapades. |
| effectiveStartDate | sträng i UTC-datumtidsformat | Det datum då prenumerationen startar. |
| commitmentEndDate | sträng i UTC-datumtidsformat | Det datum då prenumerationen upphör. |
| currentStateEndDate | sträng i UTC-datumtidsformat | Det datum då prenumerationens aktuella status ändras. |
| trialToPaidConversionDate | sträng i UTC-datumtidsformat | Det datum då prenumerationen konverteras från utvärderingsversion till betald. Standardvärdet är null. |
| trialStartDate | sträng i UTC-datumtidsformat | Det datum då utvärderingsperioden för prenumerationen startade. Standardvärdet är null. |
| lastUsageDate | sträng i UTC-datumtidsformat | Det datum då prenumerationen senast användes. Standardvärdet är null. |
| deprovisionedDate | sträng i UTC-datumtidsformat | Det datum då prenumerationen avetablerades. Standardvärdet är null. |
| lastRenewalDate | sträng i UTC-datumtidsformat | Datumet då prenumerationen senast förnyades. Standardvärdet är null. |
Filterfält
I följande tabell visas valfria filterfält och deras beskrivningar:
| Fält | Typ | Description |
|---|---|---|
| top | int | Antalet rader med data som ska returneras i begäran. Om värdet inte anges är det maximala värdet och standardvärdet 10 0000. Om det finns fler rader i frågan innehåller svarstexten en nästa länk som du kan använda för att begära nästa sida med data. |
| hoppa över | int | Antalet rader som ska hoppa över i frågan. Använd den här parametern för att bläddra igenom stora datamängder. Till exempel hämtar top=10000 och skip=0 de första 1 0000 dataraderna, top=10000 och skip=10000 hämtar de kommande 1 0000 dataraderna. |
| filter | sträng | En eller flera instruktioner som filtrerar raderna i svaret. Varje filtersats innehåller ett fältnamn från svarstexten och ett värde som är associerat med operatorn eqcontains , neeller för vissa fält. Instruktioner kan kombineras med eller andor. Strängvärden måste omges av enkla citattecken i filterparametern. I följande avsnitt finns en lista över fält som kan filtreras och de operatorer som stöds med dessa fält. |
| aggregationLevel | sträng | Anger det tidsintervall för vilket aggregerade data ska hämtas. Kan vara en av följande strängar: dag, vecka eller månad. Om värdet inte anges är standardvärdet dateRange. Obs! Den här parametern gäller endast när ett datumfält skickas som en del av parametern groupBy. |
| groupBy | sträng | En instruktion som endast tillämpar dataaggregering på de angivna fälten. |
Begärandehuvuden
Mer information finns i REST-huvuden i Partnercenter.
Begärandetext
Inga.
Exempel på begäran
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-svar
Om det lyckas innehåller svarstexten en samling prenumerationsresurser grupperade efter angivna villkor och datum.
Svarsframgång och felkoder
Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och ytterligare felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och ytterligare parametrar. Den fullständiga listan finns i Felkoder.
Exempel på svar
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
}