reportRoot: getSharePointActivityUserCounts
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 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 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/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. |
Esse método dá suporte ao $format
parâmetro de consulta OData 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
- Página visitada
- Exibidos ou editados
- Sincronizados
- Compartilhados internamente
- Compartilhados externamente
- Data do relató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.
Exemplo
CSV
Aqui está um exemplo que gera CSV.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/reports/getSharePointActivityUserCounts(period='D7')?$format=text/csv
Resposta
O exemplo a seguir mostra a 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
JSON
Aqui está um exemplo que retorna JSON.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/reports/getSharePointActivityUserCounts(period='D7')?$format=application/json
Resposta
O exemplo a seguir mostra a 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: 302
{
"value": [
{
"reportRefreshDate": "2017-09-01",
"visitedPage": 56,
"viewedOrEdited": 163,
"synced": 7,
"sharedInternally": 10,
"sharedExternally": 1,
"reportDate": "2017-09-01",
"reportPeriod": "7"
}
]
}
Comentários
https://aka.ms/ContentUserFeedback.
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, consulteEnviar e exibir comentários de