reportRoot: getTeamsUserActivityTotalDistributionCounts
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 o número de atividades de usuário do Microsoft Teams durante o período selecionado. Os tipos de atividade são mensagens de chat em equipe, mensagens de chat privadas, chamadas, reuniões, reuniões organizadas, reuniões atendidas, duração do áudio, duração do vídeo, duração do compartilhamento de tela, mensagens de postagem e mensagens de resposta.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
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. |
Observação: Para que as permissões delegadas permitam que os aplicativos leiam relatórios de uso do serviço em nome de um usuário, o administrador do locatário deve ter atribuído ao usuário a função de administrador adequada Microsoft Entra ID limitada. Para obter mais informações, confira Autorização para APIs lerem relatórios de uso do Microsoft 365.
Solicitação HTTP
GET /reports/getTeamsUserActivityTotalDistributionCounts(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 Dn, em que n representa o número de dias em que o relatório é agregado. Obrigatório. |
Parâmetros de consulta opcionais
Esse método dá suporte aos $format
parâmetros de consulta , $top
e $skipToken
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
para definir a saída padrão 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.
URLs de download pré-autenticadas são válidas apenas por um curto período de tempo (alguns minutos) e não exigem 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
- Reuniões Organizadas
- Reuniões atendidas
- Duração do Áudio
- Duração do Vídeo
- Duração do Compartilhamento de Tela
- Postar Mensagens
- Mensagens de Resposta
- Período de Relatório
JSON
Se for bem-sucedido, esse método retornará um 200 OK
código de resposta e um objeto JSON no corpo da resposta.
O tamanho da página padrão dessa solicitação é de 2.000 itens.
Exemplos
Exemplo 1: saída CSV
Aqui está um exemplo que gera CSV.
Solicitação
Aqui está um exemplo da solicitação.
GET https://graph.microsoft.com/beta/reports/getTeamsUserActivityTotalDistributionCounts(period='D7')?$format=text/csv
Resposta
Veja 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 que baixa o esquema a seguir.
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Report Refresh Date,Team Chat Messages,Private Chat Messages,Calls,Meetings,Meetings Organized,Meetings Attended,Audio Duration,Video Duration,Screen Share Duration,Post Messages,Reply Messages,Report Period
Exemplo 2: saída JSON
Aqui está um exemplo que retorna JSON.
Solicitação
Aqui está um exemplo da solicitação.
GET https://graph.microsoft.com/beta/reports/getTeamsUserActivityTotalDistributionCounts(period='D7')?$format=application/json
Resposta
Veja 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: 661
{
"@odata.context": "https://graph.microsoft.com/beta/getTeamsUserActivityTotalDistributionCounts(period='D7')?$format=application/json&$skiptoken=D07uj",
"value": [
"reportRefreshDate": "2021-09-01",
"userCounts"
{
"reportPeriod":7,
"teamChatMessages": 26,
"privateChatMessages": 17,
"calls": 4,
"meetings": 0,
"audioDuration": 00:00:00,
"videoDuration": 00:00:00,
"screenShareDuration": 00:00:00,
"meetingsOrganized": 0,
"meetingsAttended": 0,
"postMessages": 1,
"replyMessages": 1
}
]
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de