Obtención de análisis de suscripciones agrupados por fechas o términos

  • Artículo

Se aplica a: Centro de partners | Centro de partners operado por 21Vianet | Centro de partners para Microsoft Cloud for US Government

Cómo obtener información de análisis de suscripciones para los clientes agrupados por fechas o términos.

Requisitos previos

Solicitud REST

Sintaxis de la solicitud

Método URI de la solicitud
GET {baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Parámetros del identificador URI

Use los siguientes parámetros de ruta de acceso necesarios para identificar la organización y agrupar los resultados.

Nombre Tipo Obligatorio Descripción
groupby_queries pares de cadenas y dateTime Sí Términos y fechas para filtrar el resultado.

Sintaxis de GroupBy

El parámetro group by debe estar compuesto como una serie de valores de campo separados por comas.

Este sería un ejemplo de un filtro sin codificar: 

?groupby=termField1,dateField1,termField2

En la tabla siguiente se muestra una lista de los campos admitidos para agrupar por.

Campo Tipo Descripción
customerTenantId string Cadena con formato GUID que identifica el inquilino del cliente.
customerName string Nombre del cliente.
customerMarket string País o región en el que el cliente hace negocios.
id string Cadena con formato de GUID que identifica la suscripción.
status string Estado de la suscripción. Los valores admitidos son: "ACTIVE", "SUSPENDED" o "DEPROVISIONED".
ProductName string Nombre del producto.
subscriptionType string Tipo de suscripción. Nota: Este campo distingue mayúsculas de minúsculas. Los valores admitidos son: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled Boolean Valor que indica si la suscripción se renueva automáticamente.
partnerId string The PartnerID. Para un revendedor directo, este parámetro será el PartnerID del asociado. Para un revendedor indirecto, este parámetro será partnerID del revendedor indirecto.
friendlyName string Nombre de la suscripción.
partnerName string Nombre del asociado para el que se compró la suscripción
providerName string Cuando la transacción de suscripción es para el revendedor indirecto, el nombre del proveedor es el proveedor indirecto que compró la suscripción.
creationDate cadena en formato de fecha y hora UTC Fecha en que se creó la suscripción.
effectiveStartDate cadena en formato de fecha y hora UTC Fecha en que se inicia la suscripción.
commitmentEndDate cadena en formato de fecha y hora UTC Fecha en que finaliza la suscripción.
currentStateEndDate cadena en formato de fecha y hora UTC Fecha en que cambiará el estado actual de la suscripción.
trialToPaidConversionDate cadena en formato de fecha y hora UTC Fecha en la que la suscripción se convierte de prueba a pago. El valor predeterminado es null.
trialStartDate cadena en formato de fecha y hora UTC Fecha en que se inició el período de prueba de la suscripción. El valor predeterminado es null.
lastUsageDate cadena en formato de fecha y hora UTC Fecha en que se usó la suscripción por última vez. El valor predeterminado es null.
desaprovisionedDate cadena en formato de fecha y hora UTC Fecha en que se desaprovisionó la suscripción. El valor predeterminado es null.
lastRenewalDate cadena en formato de fecha y hora UTC Fecha en la que se renueve por última vez la suscripción. El valor predeterminado es null.

Campos de filtro

En la tabla siguiente se enumeran los campos de filtro opcionales y sus descripciones:

Campo Tipo Descripción
top int Número de filas de datos que se devuelven 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 que puedes usar para solicitar la siguiente página de datos.
skip int Número de filas que se omiten en la consulta. Usa este parámetro para consultar grandes conjuntos de datos. Por ejemplo, top=10000 y skip=0 recupera las primeras 10000 filas de datos, top=10000 y skip=10000 recupera las siguientes 10000 filas de datos.
filter string Una o más 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. Ten en cuenta que en el parámetro filter los valores de la cadena deben estar entre comillas simples. Consulte la sección siguiente para obtener una lista de campos que se pueden filtrar y los operadores que se admiten con esos campos.
aggregationLevel string Especifica el intervalo de tiempo necesario para el que quieres recuperar 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. Nota: Este parámetro solo se aplica cuando se pasa un campo de fecha como parte del parámetro groupBy.
Groupby string Una instrucción que aplica la agregación de datos únicamente 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?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105123
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 agrupados por los términos y fechas especificados.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales. Para obtener la lista completa, consulte Códigos de error.

Ejemplo de respuesta

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-RequestId: ec8f62e5-1d92-47e9-8d5d-1924af105123
{
  "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
}

Consulte también

Análisis del Centro de partners: recursos