Obtenha todas as informações de análise de subscrição
Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud para o Governo dos EUA
Este artigo descreve como obter todas as informações de análise de assinatura para seus clientes.
Pré-requisitos
- Credenciais conforme descrito em autenticação do Partner Center. Este cenário suporta autenticação apenas com credenciais de Utilizador.
Pedido REST
Sintaxe da solicitação
Método | Solicitar URI |
---|---|
OBTER | {baseURL}/partner/v1/analytics/subscriptions HTTP/1.1 |
Parâmetros de URI
A tabela a seguir lista parâmetros opcionais e suas descrições:
Parâmetro | Tipo | Descrição |
---|---|---|
Início | 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 próximo link que você pode usar para solicitar a próxima página de dados. |
pular | 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 10.000 linhas de dados, top=10000 e skip=10000 recupera as próximas 10.000 linhas de dados. |
filtrar | cadeia de caracteres | Uma ou mais instruções que filtram as linhas da resposta. Cada instrução de filtro contém um nome de campo do corpo da resposta e um valor que estão associados aos operadores eq , ne ou, no caso de determinados campos, contains . 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 filtro. 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. |
nível de agregação | string | Especifica o intervalo de tempo para o qual recuperar dados agregados. Pode ser uma das seguintes cadeias de caracteres: dia, semanaou 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. |
agrupar por | string | Uma instrução que aplica a agregação de dados somente aos campos especificados. |
Cabeçalhos de solicitação
Para obter mais informações, consulte cabeçalhos REST do Partner Center.
Corpo do pedido
Nenhuma.
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 REST
Se for bem-sucedida, o corpo da resposta conterá 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 de depuração extras. 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": "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"
}