Compartilhar via

reportRoot: getTeamsTeamActivityDetail

  • Artigo

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 Versão.

Obtenha detalhes sobre a atividade do Microsoft Teams por equipa. Os números incluem atividades para utilizadores licenciados e não licenciados.

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

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

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.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegada (conta corporativa ou de estudante) Reports.Read.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Reports.Read.All Indisponível.

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

Parâmetros de função

No URL do pedido, forneça os seguintes parâmetros com um valor válido.

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

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

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

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
  • Nome da Equipe
  • ID da Equipa
  • Tipo de equipa
  • Data da última atividade
  • Período de Relatório
  • Usuários ativos
  • Canais Ativos
  • Convidados
  • Reações
  • Reuniões Organizadas
  • Postar Mensagens
  • Mensagens de Resposta
  • Mensagens de Canal
  • Mensagens Urgentes
  • Menções
  • Canais Partilhados Ativos
  • Utilizadores Externos Ativos

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/getTeamsTeamActivityDetail(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 arquivo CSV baixado terá o seguinte esquema.

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

Report Refresh Date,Team Name,Team Id,Team Type,Last Activity Date,Report Period,Active Users,Active Channels,Guests,Reactions,Meetings Organized,Post Messages,Reply Messages,Channel Messages,Urgent Messages,Mentions,Active Shared Channels,Active External Users

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/getTeamsTeamActivityDetail(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: 876

{
  "@odata.context": "https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDetail(period='D7')?$format=application/json&$skiptoken=D07uj", 
  "value": [
    {
      "reportRefreshDate": "2021-09-01", 
      "teamName": "sampleTeam",
      "teamId": "a063d832-ae9a-467d-8cb4-17c073260890",
      "teamType": "Private",
      "lastActivityDate": "2021-09-01",
      "details": [
        {
          "reportPeriod":7,
          "activeUsers": 26, 
          "activeChannels": 17, 
          "guests": 4, 
          "reactions": 36, 
          "meetingsOrganized": 0,
          "postMessages": 0,
          "replyMessages": 0,
          "channelMessages": 0,
          "urgentMessages": 0,
          "mentions": 0,
          "activeSharedChannels": "6",
          "activeExternalUsers": "8"
        }
      ]
    }
  ]
}