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 de versão.

Obter detalhes sobre Microsoft 365 grupos por grupo.

Observação: Para obter detalhes sobre diferentes exibições de relatório e nomes, consulte Microsoft 365 relatórios - Microsoft 365 grupos.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante)	Reports.Read.All
Delegada (conta pessoal da Microsoft)	Sem suporte.
Aplicativo	Reports.Read.All

Observação: para permissões delegadas para permitir que os aplicativos leiam os relatórios de uso de serviço em nome de um usuário, o administrador de locatários deve atribuir a função apropriada de administrador limitada do Azure AD ao usuário. Para saber mais, confira Autorização para APIs lerem os 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 D n, 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.

Este método oferece suporte aos Parâmetros de consulta OData $format, $top e $skipToken para personalizar as 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.

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.

As URLs de download previamente autenticadas são válidas apenas por um curto período de tempo (alguns minutos) e não exigem um cabeçalho Authorization.

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
• 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 são suportadas na Microsoft Graph China operada pela 21Vianet:

• Contagem de mensagens postadas no Yammer
• Contagem de mensagens lidas no Yammer
• Contagem de mensagens curtidas no Yammer

JSON

Se tiver êxito, este método retornará um código de resposta e um 200 OK objeto office365GroupsActivityDetail no corpo da resposta.

As seguintes propriedades no objeto office365GroupsActivityDetail não são suportadas no Microsoft Graph China operado pela 21Vianet:

• yammerPostedMessageCount
• yammerReadMessageCount
• yammerLikedMessageCount

O tamanho padrão da página para essa solicitação é de 200 itens.

Exemplo

CSV

A seguir, um exemplo que dá saída ao CSV.

Solicitação

Este é um exemplo de solicitação.

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

Resposta

Este é 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 baixado terá o seguinte esquema.

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,Exchange Mailbox Total Item Count,Exchange Mailbox Storage Used (Byte),SharePoint Total File Count,SharePoint Site Storage Used (Byte),Group Id,Report Period

JSON

A seguir, um exemplo que retorna JSON.

Solicitação

Este é um exemplo de solicitação.

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

Resposta

Este é 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, 
      "exchangeMailboxTotalItemCount": 343, 
      "exchangeMailboxStorageUsedInBytes": 3724609, 
      "sharePointTotalFileCount": 0, 
      "sharePointSiteStorageUsedInBytes": 0, 
      "reportPeriod": "30"
    }
  ]
}