Obter análise de assinatura agrupada por datas ou termos

Artigo
07/17/2024

Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government

Como obter informações de análise de assinatura para seus clientes agrupadas por datas ou termos.

Pré-requisitos

Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá suporte apenas à autenticação com credenciais de usuário.

Solicitação REST

Sintaxe da solicitação

Método	URI da solicitação
GET	{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Parâmetros do URI

Use os seguintes parâmetros de caminho necessários para identificar sua organização e agrupar os resultados.

Nome	Type	Obrigatório	Descrição
groupby_queries	pares de cadeias de caracteres e dateTime	Sim	Os termos e datas para filtrar o resultado.

Sintaxe GroupBy

O parâmetro group by deve ser composto como uma série de valores de campo separados por vírgulas.

Um exemplo não codificado tem esta aparência:

?groupby=termField1,dateField1,termField2

A tabela a seguir mostra uma lista dos campos com suporte para group by.

Campo	Type	Descrição
customerTenantId	string	Uma cadeia de caracteres formatada por GUID que identifica o locatário do cliente.
customerName	string	O nome do cliente.
customerMarket	string	O país/região em que o cliente faz negócios.
id	string	Uma cadeia com formato de GUID que identifica a assinatura.
status	string	O status da assinatura. Os valores com suporte são: "ACTIVE", "SUSPENDED" ou "DEPROVISIONED".
productName	string	O nome do produto.
Subscriptiontype	string	O tipo de assinatura. Observação: esse campo diferencia maiúsculas de minúsculas. Os valores com suporte são: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled	Booliano	Um valor que indica se a assinatura é renovada automaticamente.
partnerId	string	A PartnerID. Para um revendedor direto, esse parâmetro será o PartnerID do parceiro. Para um revendedor indireto, esse parâmetro será o PartnerID do revendedor indireto.
friendlyName	string	O nome da assinatura.
partnerName	string	Nome do parceiro para o qual a assinatura foi comprada
providerName	string	Quando a transação de assinatura é para o revendedor indireto, o nome do provedor é o provedor indireto que comprou a assinatura.
creationDate	cadeia de caracteres no formato de data e hora em UTC	A data em que a assinatura foi criada.
effectiveStartDate	cadeia de caracteres no formato de data e hora em UTC	A data em que a assinatura é iniciada.
commitmentEndDate	cadeia de caracteres no formato de data e hora em UTC	A data em que a assinatura termina.
currentStateEndDate	cadeia de caracteres no formato de data e hora em UTC	A data em que o status atual da assinatura será alterado.
trialToPaidConversionDate	cadeia de caracteres no formato de data e hora em UTC	A data em que a assinatura é convertida de avaliação para paga. O valor padrão é nulo.
trialStartDate	cadeia de caracteres no formato de data e hora em UTC	A data em que o período de avaliação da assinatura foi iniciado. O valor padrão é nulo.
lastUsageDate	cadeia de caracteres no formato de data e hora em UTC	A data em que a assinatura foi usada pela última vez. O valor padrão é nulo.
deprovisionedDate	cadeia de caracteres no formato de data e hora em UTC	A data em que a assinatura foi desprovisionada. O valor padrão é nulo.
lastRenewalDate	cadeia de caracteres no formato de data e hora em UTC	A data em que a assinatura foi renovada pela última vez. O valor padrão é nulo.

Campos de filtro

A tabela a seguir lista os campos de filtro opcionais e suas descrições:

Campo	Type	Descrição
top	INT	O número de linhas de dados a serem retornadas na solicitação. Se o valor não for especificado, o valor máximo e o valor padrão serão 10000. Se houver mais linhas na consulta, o corpo da resposta incluirá um link que você poderá usar para solicitar a próxima página de dados.
skip	INT	O número de linhas a serem ignoradas na consulta. Use este parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recupera as primeiras 10000 linhas de dados, top=10000 e skip=10000 recupera as próximas 10000 linhas de dados.
filter	string	Uma ou mais instruções que filtram as linhas na resposta. Cada instrução de filtro contém um nome de campo do corpo da resposta e um valor associado ao `eq`operador , `ne`ou para determinados campos `contains` . As instruções podem ser combinadas usando `and` ou `or`. Os valores de sequência devem estar entre aspas simples no parâmetro filter. Consulte a seção a seguir para obter uma lista de campos que podem ser filtrados e os operadores com suporte com esses campos.
aggregationLevel	string	Especifica o intervalo de tempo para o qual recuperar dados agregados. Pode ser uma das seguintes cadeias de caracteres: day, week ou month. Se o valor não for especificado, o padrão será dateRange. Observação: esse parâmetro só se aplica quando um campo de data é passado como parte do parâmetro groupBy.
Groupby	string	Uma instrução que aplica a agregação de dados apenas aos campos especificados.

Cabeçalhos de solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Nenhum.

Exemplo de solicitação

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

Resposta REST

Se tiver êxito, o corpo da resposta conterá uma coleção de recursos de Assinatura agrupados pelos termos e datas especificados.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de Erro.

Exemplo de resposta

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
}

Confira também

Análise do Partner Center – recursos

Compartilhar via