reportRoot: getOffice365GroupsActivityDetail
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 de grupos do Microsoft 365 por grupo.
Nota: Para obter detalhes sobre diferentes exibições e nomes de relatório, confira Relatórios do Microsoft 365 – grupos do Microsoft 365.
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/getOffice365GroupsActivityDetail(period='{period_value}')
GET /reports/getOffice365GroupsActivityDetail(date={date_value})
Parâmetros de função
Na URL da solicitação, forneça um valor válido a um dos seguintes parâmetros.
| 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. |
| data | Data | Especifica a data para a qual você deseja visualizar os usuários que realizaram qualquer atividade. {date_value} deve ter um formato de AAAA-MM-DD. Como este relatório está disponível apenas para os últimos 30 dias, {date_value} deve ser uma data desse intervalo. |
Observação: você precisa definir o período ou data na URL.
Esse método dá suporte aos $formatparâmetros de consulta , $tope $skipTokenOData 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. Saiba mais sobre autenticação e autorizaçã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.
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
- Nome de exibição do grupo
- Excluído
- Nome principal do proprietário
- Data da última atividade
- Tipo de grupo
- Contagem de Membros
- Contagem de membros externos
- Contagem de emails recebidos do Exchange
- Contagem de arquivos ativos do SharePoint
- Contagem de mensagens postadas no Yammer
- Contagem de mensagens lidas no Yammer
- Contagem de mensagens curtidas no Yammer
- Contagem de mensagens do Canal do Teams
- Contagem organizada de reuniões do Teams
- Quantidade de itens totais da caixa de correio do Exchange
- Armazenamento utilizado da caixa de correio do Exchange (bytes)
- Contagem total de arquivos do SharePoint
- Armazenamento utilizado do site do SharePoint (bytes)
- ID do grupo
- Período de Relatório
As seguintes colunas não têm suporte no Microsoft Graph China operado pela 21Vianet:
- Contagem de mensagens postadas no Yammer
- Contagem de mensagens lidas no Yammer
- Contagem de mensagens curtidas no Yammer
- Contagem de mensagens do Canal do Teams
- Contagem organizada de reuniões do Teams
JSON
Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto office365GroupsActivityDetail no corpo da resposta.
As seguintes propriedades no objeto office365GroupsActivityDetail não têm suporte no Microsoft Graph China operado pela 21Vianet:
- yammerPostedMessageCount
- yammerReadMessageCount
- yammerLikedMessageCount
- teamsChannelMessagesCount
- teamsMeetingsOrganizedCount
O tamanho da página padrão para essa solicitação é de 200 itens.
Exemplo
CSV
Aqui está um exemplo que gera CSV.
Solicitação
Aqui está um exemplo da solicitação.
GET https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityDetail(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,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Member Count,External Member Count,Exchange Received Email Count,SharePoint Active File Count,Yammer Posted Message Count,Yammer Read Message Count,Yammer Liked Message Count,Teams Channel Messages Count,Teams Meetings Organized Count,Exchange Mailbox Total Item Count,Exchange Mailbox Storage Used (Byte),SharePoint Total File Count,SharePoint Site Storage Used (Byte),Group Id,Report Period
JSON
Aqui está um exemplo que retorna JSON.
Solicitação
Aqui está um exemplo da solicitação.
GET https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityDetail(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: 674
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365GroupsActivityDetail)",
"value": [
{
"groupId": "0003cf63-7ff3-4471-b24b-50ffbfb8b5d2",
"reportRefreshDate": "2017-09-01",
"groupDisplayName": "groupDisplayName-value",
"isDeleted": false,
"ownerPrincipalName": "ownerDisplayName-value",
"lastActivityDate": "2017-08-31",
"groupType": "Private",
"memberCount": 5,
"externalMemberCount": 0,
"exchangeReceivedEmailCount": 341,
"sharePointActiveFileCount": 0,
"yammerPostedMessageCount": 0,
"yammerReadMessageCount": 0,
"yammerLikedMessageCount": 0,
"teamsChannelMessagesCount": 0,
"teamsMeetingsOrganizedCount": 0,
"exchangeMailboxTotalItemCount": 343,
"exchangeMailboxStorageUsedInBytes": 3724609,
"sharePointTotalFileCount": 0,
"sharePointSiteStorageUsedInBytes": 0,
"reportPeriod": "30"
}
]
}
Comentários
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, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de