reportRoot: getOffice365ActiveUserCounts

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Obtenha a contagem de usuários ativos diários no período de relatório por produto.

Observação: Para saber mais sobre os diferentes modos de exibição de relatório e nomes, confira Relatórios do Microsoft 365 - Usuários Ativos.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante)	Reports.Read.All
Delegada (conta pessoal da Microsoft)	Sem suporte.
Aplicativo	Reports.Read.All

Observação: para permissões delegadas para permitir que os aplicativos leiam os relatórios de uso de serviço em nome de um usuário, o administrador de locatários deve atribuir a função apropriada de administrador limitada do Azure AD ao usuário. Para saber mais, confira Autorização para APIs lerem os relatórios de uso do Microsoft 365.

Solicitação HTTP

GET /reports/getOffice365ActiveUserCounts(period='{period_value}')

Parâmetros de função

Na URL da solicitação, forneça um valor válido ao seguinte parâmetro.

Parâmetro	Tipo	Descrição
ponto	cadeia de caracteres	Especifica o período de tempo durante o qual o relatório é agregado. Os valores com suporte para {period_value} são: D7, D30, D90 e D180. Eles seguem o formato D n, em que n representa o número de dias em que o relatório é agregado. Obrigatório.

Esse método dá suporte ao$format parâmetro de consulta OData para personalizar a resposta. O tipo de saída padrão é text/csv. No entanto, se você quiser especificar o tipo de saída, poderá usar o parâmetro de consulta OData $format definido como text/csv ou application/json.

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório.

Resposta

CSV

Se for bem-sucedido, este método retorna uma resposta 302 Found que redireciona para uma URL de download pré-autenticada para o relatório. Essa URL pode ser encontrada no cabeçalho Location na resposta.

As URLs de download previamente autenticadas são válidas apenas por um curto período de tempo (alguns minutos) e não exigem um cabeçalho Authorization.

O arquivo CSV possui os seguintes cabeçalhos para colunas:

• Data de atualização do relatório
• Office 365
• Exchange
• OneDrive
• SharePoint
• Skype for Business
• Yammer
• Teams
• Data do relatório
• Período de Relatório

As seguintes colunas não são suportadas na Microsoft Graph China operada pela 21Vianet:

• Yammer
• Teams

JSON

Se tiver êxito, este método retornará um código de resposta e um 200 OK objeto office365ActiveUserCounts no corpo da resposta.

As seguintes propriedades no objeto office365ActiveUserCounts não são suportadas no Microsoft Graph China operado pela 21Vianet:

• yammer
• teams

Exemplo

CSV

A seguir, um exemplo que dá saída ao CSV.

Solicitação

Este é um exemplo de solicitação.

GET https://graph.microsoft.com/beta/reports/getOffice365ActiveUserCounts(period='D7')?$format=text/csv

Resposta

Este é um exemplo de resposta.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

Siga o redirecionamento 302 e o arquivo CSV baixado terá o seguinte esquema.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,Office 365,Exchange,OneDrive,SharePoint,Skype For Business,Yammer,Teams,Report Date,Report Period

JSON

A seguir, um exemplo que retorna JSON.

Solicitação

Este é um exemplo de solicitação.

GET https://graph.microsoft.com/beta/reports/getOffice365ActiveUserCounts(period='D7')?$format=application/json

Resposta

Este é um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 317

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365ActiveUserCounts)", 
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "office365": 1718, 
      "exchange": 1429, 
      "oneDrive": 350, 
      "sharePoint": 795, 
      "skypeForBusiness": 251, 
      "yammer": 47, 
      "teams": 10, 
      "reportDate": "2017-08-29", 
      "reportPeriod": "7"
    }
  ]
}