reportRoot: getTeamsTeamActivityDistributionCounts

Namespace: microsoft.graph

Obtenha o número de atividades de equipa no Microsoft Teams durante um período selecionado.

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 deve 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/getTeamsTeamActivityDistributionCounts(period='{period_value}')

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 é text/csv. No entanto, se quiser especificar o tipo de saída, pode utilizar o parâmetro de consulta OData $format para definir o resultado predefinido 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
• Período de Relatório
• Usuários ativos
• Canais Ativos
• Convidados
• Reações
• Reuniões Organizadas
• Postar Mensagens
• Mensagens de Canal
• Canais Partilhados Ativos
• Utilizadores Externos Ativos
• Mensagens de Resposta
• Mensagens Urgentes
• Menções

JSON

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

Exemplos

Exemplo 1: saída CSV

Eis um exemplo que produz CSV.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDistributionCounts(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,Report Period,Active Users,Active Channels,Guests,Reactions,Meetings Organized,Post Messages,Channel Messages,Active Shared Channels,Active External Users,Reply Messages,Urgent Messages,Mentions

Exemplo 2: saída JSON

Eis um exemplo que devolve JSON.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDistributionCounts(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: 575

{
  "@odata.context": "https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDistributionCounts(period='D7')?$format=application/json&$skiptoken=D07uj", 
  "value": [
    {
      "reportRefreshDate": "2021-09-01", 
      "userCounts": [
        "reportPeriod":7,
        "activeUsers": 26, 
        "activeChannels": 17, 
        "guests": 4, 
        "reactions": 36, 
        "meetingsOrganized": 0,
        "postMessages": 83,
        "channelMessages": 101,
        "activeSharedChannels": 1,
        "activeExternalUsers": 2,
        "replyMessages":10,
        "urgentMessages":8,
        "mentions":1
      ]
    }
  ]
}