Obtener toda la información de análisis de las suscripciones
Se aplica a: Centro de partners | Centro de partners operado por 21Vianet | Centro de partners para Microsoft Cloud for US Government
En este artículo se describe cómo obtener toda la información de análisis de suscripciones para los clientes.
Requisitos previos
- Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario solo admite la autenticación con credenciales de usuario.
Solicitud REST
Sintaxis de la solicitud
| Método | URI de solicitud |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions HTTP/1.1 |
Parámetros del identificador URI
En la tabla siguiente se enumeran los parámetros opcionales y sus descripciones:
| Parámetro | Type | Descripción |
|---|---|---|
| top | int | Número de filas de datos que se van a devolver en la solicitud. Si no se especifica el valor, el valor máximo y el valor predeterminado son 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo siguiente que puede usar para solicitar la siguiente página de datos. |
| skip | int | Número de filas que se van a omitir en la consulta. Use este parámetro para paginar conjuntos de datos grandes. Por ejemplo, top=10000 y skip=0 recupera las primeras 10 000 filas de datos top=10000 y skip=10000 recupera las siguientes 10 000 filas de datos. |
| filter | cadena | Una o varias instrucciones que filtran las filas de la respuesta. Cada instrucción de filtro contiene un nombre de campo del cuerpo de la respuesta y un valor asociado a eq, neo para determinados campos, el contains operador . Las instrucciones se pueden combinar mediante and o or. Los valores de cadena deben estar rodeados de comillas simples en el parámetro de filtro . Consulte la siguiente sección para obtener una lista de campos que se pueden filtrar y los operadores que se admiten con esos campos. |
| aggregationLevel | cadena | Especifica el intervalo de tiempo para el que se van a recuperar los datos agregados. Puede ser una de las siguientes cadenas: día, semana o mes. Si no se especifica el valor, el valor predeterminado es dateRange. Este parámetro solo se aplica cuando se pasa un campo de fecha como parte del parámetro groupBy . |
| Groupby | cadena | Instrucción que aplica la agregación de datos solo a los campos especificados. |
Encabezados de solicitud
Para obtener más información, consulta Encabezados REST del Centro de partners.
Cuerpo de la solicitud
Ninguno.
Ejemplo de solicitud
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0
Respuesta REST
Si se ejecuta correctamente, el cuerpo de la respuesta contiene una colección de recursos de suscripción.
Códigos de error y de respuesta correctos
Cada respuesta incluye un código de estado HTTP que indica el éxito o error y la información adicional de depuración. Use una herramienta de seguimiento de red para leer este código, tipo de error y más parámetros. Para obtener la lista completa, consulte Códigos de error.
Ejemplo de respuesta
{
"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"
}