reportRoot: getSharePointSiteUsageDetail

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 dados sobre o uso do site do SharePoint.

Nota: Para obter detalhes sobre diferentes vistas e nomes de relatórios, consulte Relatórios do Microsoft 365 – utilização de sites do SharePoint.

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 tem de 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/getSharePointSiteUsageDetail(period='{period_value}')
GET /reports/getSharePointSiteUsageDetail(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.

Este método suporta os $formatparâmetros de consulta , $tope $skipTokenOData para personalizar a resposta. O tipo de saída predefinido é texto/csv. No entanto, se quiser especificar o tipo de saída, pode utilizar 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.

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
• Site Id
• URL do site
• Nome de exibição do proprietário
• Excluído
• Data da última atividade
• ID da Etiqueta de Confidencialidade do Site
• Partilha Externa
• Política de Dispositivos Não Geridos
• Localização Geográfica
• Contagem de arquivos
• Contagem de arquivos ativos
• Contagem de visualização de página
• Contagem de páginas visitadas
• Contagem de Ligações Anónimas
• Contagem de Ligações da Empresa
• Ligação Segura para Contagem de Convidados
• Ligação Segura para Contagem de Membros
• Armazenamento utilizado (bytes)
• Armazenamento alocado (bytes)
• Modelo de Web raiz
• Nome principal do proprietário
• Período de Relatório

JSON

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

O tamanho de página predefinido para este pedido é de 200 itens.

Exemplo

CSV

Eis um exemplo que produz CSV.

Solicitação

Eis um exemplo do pedido.

GET https://graph.microsoft.com/beta/reports/getSharePointSiteUsageDetail(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 ficheiro CSV que as transferências têm o seguinte esquema.

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

Report Refresh Date,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,Site Sensitivity Label Id,External Sharing,Unmanaged Device Policy,Geo Location,File Count,Active File Count,Page View Count,Visited Page Count,Anonymous Link Count,Company Link Count,Secure Link For Guest Count,Secure Link For Member Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period

JSON

Eis um exemplo que devolve JSON.

Solicitação

Eis um exemplo do pedido.

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

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "siteId": "siteId-value", 
      "siteUrl": "siteUrl-value", 
      "ownerDisplayName": "ownerDisplayName-value", 
      "ownerPrincipalName": "ownerPrincipalName-value", 
      "isDeleted": false, 
      "lastActivityDate": "2017-09-01", 
      "siteSensitivityLabelId": "SiteSensitivityLabelId-value",
      "externalSharing": false,
      "unmanagedDevicePolicy": "UnmanagedDevicePolicy-value",
      "geoLocation": "GeoLocation-value",
      "fileCount": 170, 
      "activeFileCount": 25, 
      "pageViewCount": 7, 
      "visitedPageCount": 3, 
      "anonymousLinkCount": 5,
      "companyLinkCount": 8,
      "secureLinkForGuestCount": 13,
      "secureLinkForMemberCount": 11,
      "storageUsedInBytes": 63442116, 
      "storageAllocatedInBytes": 2748779094400, 
      "rootWebTemplate": "Publishing Site", 
      "reportPeriod": "7"
    }
  ]
}