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 exibições e nomes de relatório, confira Relatórios do Microsoft 365 – uso do site do SharePoint.

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/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.

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
• Site Id
• URL do site
• Nome de exibição do proprietário
• Excluído
• Data da última atividade
• ID do Rótulo de Confidencialidade do Site
• Compartilhamento Externo
• Política de dispositivo não gerenciada
• 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 links anônimos
• Contagem de vínculos da empresa
• Link seguro para contagem de convidados
• Link seguro 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, 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 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/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 arquivo CSV que baixa o esquema a seguir.

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

Aqui está um exemplo que retorna JSON.

Solicitação

Aqui está um exemplo da solicitação.

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"
    }
  ]
}