reportRoot: getTeamsUserActivityDistributionTotalUserCounts

Namespace: microsoft.graph

Obtenha o número de utilizadores licenciados ou não licenciados do Microsoft Teams por tipo de atividade durante o período selecionado. Os tipos de atividade são o número de mensagens de chat das equipas, mensagens de chat privadas, chamadas e reuniões.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Nota: para permissões delegadas para permitir que as aplicações leiam relatórios de utilização do serviço em nome de um utilizador, o administrador inquilino tem de ter atribuído ao utilizador a função de administrador limitada do Microsoft Entra ID adequada. Para obter mais informações, veja Autorização para APIs para ler relatórios de utilização do Microsoft 365.

Solicitação HTTP

GET /reports/getTeamsUserActivityDistributionTotalUserCounts(period='D7')

Parâmetros de função

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

Parâmetros de consulta opcionais

Este método suporta o $formatparâmetro de consulta OData para personalizar a resposta. O tipo de saída predefinido é texto/csv. No entanto, se quiser especificar o tipo de saída, pode utilizar o parâmetro de consulta OData $format definido como text/csv ou application/json.

Cabeçalhos de solicitação

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.

Os URLs de transferência pré-autenticados só são válidos por um curto período de tempo (alguns minutos) e não requerem um Authorization cabeçalho.

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

• Data de atualização do relatório
• Mensagens de chat de equipes
• Mensagens de chat privadas
• Chamadas
• Reuniões
• Período de Relatório

JSON

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto JSON no corpo da resposta.

Exemplo

CSV

Eis um exemplo que produz CSV.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a 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 ficheiro CSV que as transferências têm o seguinte esquema.

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

Report Refresh Date,Team Chat Messages,Private Chat Messages,Calls,Meetings,Report Period

JSON

Eis um exemplo que devolve JSON.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a 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: 291

{
  "value": [
    {
      "reportRefreshDate": "2020-09-01", 
      "teamChatMessages": 0, 
      "privateChatMessages": 0, 
      "calls": 0, 
      "meetings": 0, 
      "reportPeriod": "7"
    }
  ]
}