Obter a análise de assinatura agrupada por datas ou termosGet subscription analytics grouped by dates or terms

Aplica-se aApplies To

  • Partner CenterPartner Center
  • Partner Center operado pela 21VianetPartner Center operated by 21Vianet
  • Partner Center do Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany
  • Partner Center do Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Como obter informações de análise de assinatura para seus clientes agrupados por datas ou termos.How to get subscription analytics information for your customers grouped by dates or terms.

Pré-requisitosPrerequisites

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET * { baseURL } */Partner/v1/Analytics/subscriptions? GroupBy = {groupby_queries}{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Parâmetros do URIURI parameters

Use os seguintes parâmetros de caminho necessários para identificar sua organização e agrupar os resultados.Use the following required path parameters to identify your organization and to group the results.

NomeName TypeType ObrigatórioRequired DescriçãoDescription
groupby_queriesgroupby_queries pares de cadeias de caracteres e dateTimepairs of strings and dateTime SimYes Os termos e datas para filtrar o resultado.The terms and dates to filter the result.

Sintaxe GroupByGroupBy syntax

O parâmetro Group by deve ser composto como uma série de valores de campo separados por vírgulas.The group by parameter must be composed as a series of comma separated, field values.

Um exemplo não codificado tem esta aparência: An unencoded example looks like this:

?groupby=termField1,dateField1,termField2

A tabela a seguir mostra uma lista dos campos com suporte para Group by.The following table shows a list of the supported fields for group by.

CampoField TipoType DescriptionDescription
customerTenantIdcustomerTenantId stringstring Uma cadeia de caracteres formatada em GUID que identifica o locatário do cliente.A GUID-formatted string that identifies the customer tenant.
customerNamecustomerName stringstring O nome do cliente.The name of the customer.
customerMarketcustomerMarket stringstring O país/região no qual o cliente faz negócios.The country/region that the customer does business in.
idid stringstring Uma cadeia com formato de GUID que identifica a assinatura.A GUID-formatted string that identifies the subscription.
statusstatus stringstring O status da assinatura.The subscription status. Os valores com suporte são: "ativo", "suspenso" ou "desprovisionado".Supported values are: "ACTIVE", "SUSPENDED", or "DEPROVISIONED".
productNameproductName stringstring O nome do produto.The name of the product.
subscriptionTypesubscriptionType stringstring O tipo de assinatura.The subscription type. Observação: esse campo diferencia maiúsculas de minúsculas.Note: This field is case sensitive. Os valores com suporte são: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".Supported values are: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabledautoRenewEnabled BooleanBoolean Um valor que indica se a assinatura é renovada automaticamente.A value indicating whether the subscription is renewed automatically.
parceiroidpartnerId stringstring A ID do MPN.The MPN ID. Para um revendedor direto, esse parâmetro será a ID de MPN do parceiro.For a direct reseller, this parameter will be the MPN ID of the partner. Para um revendedor indireto, esse parâmetro será a ID de MPN do revendedor indireto.For an indirect reseller, this parameter will be the MPN ID of the indirect reseller.
friendlyNamefriendlyName stringstring O nome da assinatura.The name of the subscription.
partnerNamepartnerName stringstring Nome do parceiro para o qual a assinatura foi adquiridaName of the partner for whom the subscription was purchased
providerNameproviderName stringstring Quando a transação de assinatura é para o revendedor indireto, o nome do provedor é o provedor indireto que comprou a assinatura.When subscription transaction is for the indirect reseller, provider name is the indirect provider who bought the subscription.
creationDatecreationDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que a assinatura foi criada.The date the subscription was created.
effectiveStartDateeffectiveStartDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que a assinatura é iniciada.The date the subscription starts.
commitmentEndDatecommitmentEndDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que a assinatura termina.The date the subscription ends.
currentStateEndDatecurrentStateEndDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que o status atual da assinatura será alterado.The date that the current status of the subscription will change.
trialToPaidConversionDatetrialToPaidConversionDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que a assinatura é convertida de avaliação para paga.The date that the subscription converts from trial to paid. O valor padrão é nulo.The default value is null.
trialStartDatetrialStartDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que o período de avaliação da assinatura foi iniciado.The date that the trial period for the subscription started. O valor padrão é nulo.The default value is null.
lastUsageDatelastUsageDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que a assinatura foi usada pela última vez.The date that the subscription was last used. O valor padrão é nulo.The default value is null.
deprovisionedDatedeprovisionedDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que a assinatura foi desprovisionada.The date that the subscription was deprovisioned. O valor padrão é nulo.The default value is null.
lastRenewalDatelastRenewalDate cadeia de caracteres no formato de data e hora em UTCstring in UTC date time format A data em que a assinatura foi renovada pela última vez.The date that the subscription was last renewed. O valor padrão é nulo.The default value is null.

Campos de filtroFilter fields

A tabela a seguir lista os campos de filtro opcionais e suas descrições:The following table lists optional filter fields and their descriptions:

CampoField TipoType DescriçãoDescription
toptop INTint O número de linhas de dados a serem retornadas na solicitação.The number of rows of data to return in the request. Se o valor não for especificado, o valor máximo e o valor padrão serão 10000.If the value isn't specified, the maximum value and the default value are 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.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data.
skipskip INTint O número de linhas a serem ignoradas na consulta.The number of rows to skip in the query. Use este parâmetro para percorrer grandes conjuntos de dados.Use this parameter to page through large data sets. 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.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data.
filtrofilter stringstring Uma ou mais instruções que filtram as linhas na resposta.One or more statements that filter the rows in the response. Cada instrução de filtro contém um nome de campo do corpo da resposta e um valor que estão associados a eq , ne ou para determinados campos, o contains operador.Each filter statement contains a field name from the response body and a value that are associated with the eq, ne, or for certain fields, the contains operator. As instruções podem ser combinadas usando and ou or .Statements can be combined using and or or. Os valores de sequência devem estar entre aspas simples no parâmetro filter.String values must be surrounded by single quotes in the filter parameter. Consulte a seção a seguir para obter uma lista de campos que podem ser filtrados e os operadores que têm suporte com esses campos.See the following section for a list of fields that can be filtered and the operators that are supported with those fields.
aggregationLevelaggregationLevel stringstring Especifica o intervalo de tempo para o qual recuperar dados agregados.Specifies the time range for which to retrieve aggregate data. Pode ser uma das seguintes cadeias de caracteres: day, week ou month.Can be one of the following strings: day, week, or month. Se o valor não for especificado, o padrão será DateRange.If the value isn't specified, the default is dateRange. Observação: esse parâmetro se aplica somente quando um campo de data é passado como parte do parâmetro GroupBy.Note: This parameter applies only when a date field is passed as part of the groupBy parameter.
groupBygroupBy stringstring Uma instrução que aplica a agregação de dados apenas aos campos especificados.A statement that applies data aggregation only to the specified fields.

Cabeçalhos de solicitaçãoRequest headers

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Corpo da solicitaçãoRequest body

Nenhum.None.

Exemplo de solicitaçãoRequest example

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

Resposta RESTREST response

Se for bem-sucedido, o corpo da resposta conterá uma coleção de recursos de assinatura agrupados pelos termos e datas especificados.If successful, the response body contains a collection of Subscription resources grouped by the specified terms and dates.

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, error type, and additional parameters. Para obter a lista completa, confira Códigos de Erro.For the full list, see Error Codes.

Exemplo de respostaResponse example

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 tambémSee also

Análise do Partner Center – recursosPartner Center Analytics - Resources