reportRoot: getYammerGroupsActivityDetail
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 as atividades de grupo do Yammer por grupo.
Nota: Para obter detalhes sobre diferentes vistas e nomes de relatórios, consulte Relatórios do Microsoft 365 – atividade de grupos do Yammer.
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 saber mais, confira Autorização para APIs lerem os relatórios de uso do Microsoft 365.
Solicitação HTTP
GET /reports/getYammerGroupsActivityDetail(period='{period_value}')
GET /reports/getYammerGroupsActivityDetail(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 $format
parâmetros de consulta , $top
e $skipToken
OData 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.
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
- Office 365 Connected
- Contagem de Membros
- Contagem de Postagens
- Contagem de Leituras
- Contagem de Curtidas
- Nome a Apresentar da Rede
- 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
Segue-se um exemplo que produz CSV.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/reports/getYammerGroupsActivityDetail(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 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,Office 365 Connected,Member Count,Posted Count,Read Count,Liked Count,Network Display Name,Report Period
JSON
Segue-se um exemplo que devolve JSON.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/reports/getYammerGroupsActivityDetail(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: 441
{
"value": [
{
"reportRefreshDate": "2017-09-01",
"groupDisplayName": "groupDisplayName-value",
"isDeleted": false,
"ownerPrincipalName": "ownerPrincipalName-value",
"lastActivityDate": "2017-08-30",
"groupType": "private",
"office365Connected": true,
"memberCount": 176,
"postedCount": 15,
"readCount": 24,
"likedCount": 3,
"networkDisplayName": "networkDisplayName-value",
"reportPeriod": "7"
}
]
}