reportRoot: getSharePointActivityUserCounts

Namespace: microsoft.graph

Obtenha a tendência no número de usuários ativos. Um usuário será considerado ativo se tiver executado uma atividade de arquivo (salvar, sincronizar, modificar ou compartilhar) ou visitar uma página dentro do período de tempo especificado.

Nota: Para obter detalhes sobre diferentes exibições e nomes de relatório, confira Relatórios do Microsoft 365 – atividade 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 Microsoft Entra limitada apropriada. Para obter mais informações, confira Autorização para APIs lerem relatórios de uso do Microsoft 365.

Solicitação HTTP

GET /reports/getSharePointActivityUserCounts(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.

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
If-None-Match	Se este cabeçalho de solicitação estiver incluso e a eTag fornecida corresponder à marca atual do arquivo, um código de resposta 304 Not Modified será exibido. Opcional.

Resposta

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
• Página visitada
• Exibidos ou editados
• Sincronizados
• Compartilhados internamente
• Compartilhados externamente
• Data do relatório
• Período de Relatório

Exemplo

Solicitação

Aqui está um exemplo da solicitação.

HTTP

GET https://graph.microsoft.com/v1.0/reports/getSharePointActivityUserCounts(period='D7')

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetSharePointActivityUserCountsWithPeriod("{period}").GetAsync();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

mgc reports get-share-point-activity-user-counts-with-period get --period {period-id}

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
period := "{period}"
graphClient.Reports().GetSharePointActivityUserCountsWithPeriod(&period).Get(context.Background(), nil)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getSharePointActivityUserCountsWithPeriod("{period}").get();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getSharePointActivityUserCounts(period='D7')')
	.get();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->reports()->getSharePointActivityUserCountsWithPeriod('{period}', )->get()->wait();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Reports

Get-MgReportSharePointActivityUserCount -Period $periodId 

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.reports.get_share_point_activity_user_counts_with_period("{period}").get()

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

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,Visited Page,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period