copilotReportRoot: getMicrosoft365CopilotUsageUserDetailByDate

Importante

As APIs sob a /beta versão estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção.

Obtenha detalhes de uso do Microsoft 365 Copilot em nível de usuário para todos os usuários relatados em uma única data selecionada.

Para obter mais informações sobre exibições e nomes de relatórios, consulte Relatórios do Microsoft 365 – Uso do Microsoft 365 Copilot. As APIs de relatórios de uso do Copilot estão disponíveis como APIs REST padrão no namespace do Microsoft Graph. Para obter mais informações, consulte Visão geral das APIs do Microsoft 365 Copilot.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados
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.

Importante

Para permissões delegadas para permitir que os aplicativos leiam relatórios de uso do serviço em nome de um usuário, o administrador do locatário deve atribuir ao usuário uma das seguintes funções de administrador limitado do Microsoft Entra ID:

  • Administrador da Empresa
  • Administrador de IA
  • Administrador do Exchange
  • Administrador do SharePoint
  • Administrador do Lync
  • Administrador de Serviço do Teams
  • Administrador de Comunicações do Teams
  • Leitor de Relatórios

Para obter mais informações, consulte Autorização para APIs lerem relatórios de uso do Microsoft 365.

Solicitação HTTP

GET https://graph.microsoft.com/beta/copilot/reports/getMicrosoft365CopilotUsageUserDetailByDate(date={date})

Parâmetros de função

Forneça os seguintes parâmetros de consulta necessários com valores na URL solicitada.

Parâmetro Tipo Descrição
date Date Obrigatório. A data para a qual a atividade dos usuários será retornada. O valor deve usar o YYYY-MM-DD formato e ser de sete dias antes da data de atualização do relatório mais recente até a data de atualização, inclusive. A janela de disponibilidade é baseada em reportRefreshDate, não na data do calendário atual. Por exemplo, se a data de atualização do relatório mais recente for 17 de setembro de 2026, os valores válidos serão 10 de setembro de 2026 a 17 de setembro de 2026, inclusive.

Parâmetros de consulta opcionais

Esse método não dá suporte a nenhum parâmetro de consulta OData para ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome Descrição
Authorization Bearer {token}. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedida, essa função retornará um 200 OK código de resposta e uma representação JSON do relatório solicitado no corpo da resposta. Cada linha do relatório contém as propriedades a seguir.

Propriedade Tipo Descrição
allAppsCopilotActionCount Int64 Número de ações do Copilot em todos os aplicativos com suporte.
businessChatWebPromptsCount Int64 Número de prompts enviados por meio do Business Chat na Web.
displayName Cadeia de caracteres Nome de exibição do usuário ou identificador oculto, dependendo das configurações do relatório.
isActive Booliano Se o usuário estava ativo em alguma experiência relatada do Copilot.
isActiveInBusinessChatWeb Booliano Atividade no Business Chat na Web.
isActiveInEdge Booliano Atividade no Microsoft Edge.
isActiveInExcel Booliano Atividade no Microsoft Excel.
isActiveInLoop Booliano Atividade no Microsoft Loop.
isActiveInM365Chat Booliano Atividade no Microsoft 365 Chat.
isActiveInM365CopilotChatCopilotApp Booliano Atividade no Microsoft 365 Copilot Chat no aplicativo Microsoft 365 Copilot.
isActiveInOneNote Booliano Atividade no Microsoft OneNote.
isActiveInOutlook Booliano Atividade no Microsoft Outlook.
isActiveInPowerPoint Booliano Atividade no Microsoft PowerPoint.
isActiveInTeams Booliano Atividade no Microsoft Teams.
isActiveInWord Booliano Atividade no Microsoft Word.
m365ChatQueriesSubmitted Int64 Número de consultas enviadas por meio do Microsoft 365 Chat.
reportRefreshDate Data Data em que os dados do relatório foram atualizados.
reportSelectedDate Data Data selecionada pela solicitação.
userPrincipalName Cadeia de caracteres Nome UPN ou identificador oculto, dependendo das configurações do relatório.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/copilot/reports/getMicrosoft365CopilotUsageUserDetailByDate(date=2026-09-14)

Resposta

O exemplo a seguir mostra a resposta. O objeto de resposta mostrado aqui pode ser reduzido para facilitar a leitura.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "reportRefreshDate": "2026-09-17",
      "reportSelectedDate": "2026-09-14",
      "userPrincipalName": "DC8C64D6EC3A3AA17481D7E5EB5B68A6",
      "displayName": "C65E8D8AFA0DAB9639EDFAAEA94AFE66",
      "allAppsCopilotActionCount": 10,
      "m365ChatQueriesSubmitted": 3,
      "businessChatWebPromptsCount": 7,
      "isActive": true,
      "isActiveInTeams": false,
      "isActiveInWord": false,
      "isActiveInPowerPoint": false,
      "isActiveInExcel": true,
      "isActiveInOutlook": false,
      "isActiveInOneNote": false,
      "isActiveInLoop": false,
      "isActiveInM365Chat": true,
      "isActiveInBusinessChatWeb": true,
      "isActiveInEdge": false,
      "isActiveInM365CopilotChatCopilotApp": false
    }
  ]
}
  • Última atualização a