Obter todas as informações de análise de subscrições

Artigo
09/22/2023

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

Este artigo descreve como obter todas as informações de análise de assinatura para seus clientes.

Pré-requisitos

Credenciais conforme descrito na autenticação do Partner Center. Este cenário suporta autenticação apenas com credenciais de Utilizador.

Pedido REST

Sintaxe da solicitação

Método	URI do pedido
GET	{baseURL}/partner/v1/analytics/assinaturas HTTP/1.1

Parâmetros de URI

A tabela a seguir lista parâmetros opcionais e suas descrições:

Parâmetro	Tipo	Descrição
top	número inteiro	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 próximo link que você pode usar para solicitar a próxima página de dados.
skip	número inteiro	O número de linhas a serem ignoradas na consulta. Use este parâmetro para percorrer grandes conjuntos de dados. Por exemplo, `top=10000` recupera as primeiras 10.000 linhas de dados e `skip=10000` recupera `skip=0` as próximas 10.000 linhas de dados`top=10000`.
filtrar	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 que estão associados ao `eq`, ou para determinados campos, `ne`o `contains` operador. As instruções podem ser combinadas usando `and` ou `or`. Os valores de cadeia de caracteres devem ser cercados por 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 que são suportados com esses campos.
agregaçãoNível	string	Especifica o intervalo de tempo para o qual recuperar dados agregados. Pode ser uma das seguintes cadeias de caracteres: dia, semana ou mês. Se o valor não for especificado, o padrão será dateRange. Este parâmetro aplica-se somente quando um campo de data é passado como parte do parâmetro groupBy .
groupBy	string	Uma instrução que aplica a agregação de dados somente aos campos especificados.

Cabeçalhos do pedido

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

Corpo do pedido

Nenhum.

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0

Resposta do REST

Se bem-sucedida, o corpo da resposta contém uma coleção de recursos de Assinatura .

Códigos de sucesso e erro de resposta

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

Exemplo de resposta

{
    "customerTenantId": "76906668-27FC-4F5B-A35C-75A9823E13AF",
    "customerName": "TESTORG65656565",
    "customerMarket": "US",
    "id": "4BF546B2-8998-4838-BEE2-5F1BBE65A04F",
    "status": "ACTIVE",
    "productName": "OFFICE 365 BUSINESS PREMIUM",
    "subscriptionType": "Office",
    "autoRenewEnabled": true,
    "partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
    "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"

}

Consulte também

Partner Center Analytics - Recursos

Partilhar via