copilotReportRoot: getMicrosoft365CopilotUsageUserDetail

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 os dados de uso mais recentes dos usuários habilitados para aplicativos do Microsoft 365 Copilot.

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.

Observação

Essa API retorna dados de uso apenas para usuários que tenham uma licença do Microsoft 365 Copilot. Os dados não licenciados de uso do Copilot Chat não estão disponíveis por meio de APIs de relatórios do Microsoft Graph. Em vez disso, você pode:

  • Exibir o uso não licenciado no Centro de Administração Microsoft 365 Relatório de uso do Copilot Chat
  • Acessar dados de auditoria por meio do Log de Auditoria do Microsoft Purview
  • Exporte programaticamente usando Search-UnifiedAuditLog o (PowerShell) ou a API de Atividade de Gerenciamento do Office 365

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 ter atribuído 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/v1.0/copilot/reports/getMicrosoft365CopilotUsageUserDetail(period={period}, version={version})

GET https://graph.microsoft.com/beta/copilot/reports/getMicrosoft365CopilotUsageUserDetail(period={period}, version={version})

Parâmetros de função

Na URL da solicitação, forneça os seguintes parâmetros de consulta com valores.

Parâmetro Tipo Descrição
period Cadeia de caracteres Obrigatório. O número de dias anteriores sobre os quais relatar o uso agregado. Os valores com suporte dependem do valor de version. Para v1, eles são: D7, D30, D90, D180ALL, . Pois v2, eles são D7, D28, D90, D180, ALL. Os primeiros quatro valores seguem o formato Dn em n que representa o número de dias anteriores sobre os quais agregar dados. ALL Indica o uso do relatório para todos os períodos com suporte (7, 30, 90 e 180 dias para v1, 7, 28, 90 e 180 dias para v2).
version String Opcional. A versão do relatório solicitada. Os valores com suporte são v1 (padrão) e v2.

Versões de relatório

Os relatórios da versão 1 contêm as informações a seguir.

  • Data de atualização do relatório
  • Nome UPN
  • Nome de exibição
  • Data da última atividade
  • Data da última atividade do Copilot Chat
  • Data da última atividade do Microsoft Teams Copilot
  • Data da última atividade do Word Copilot
  • Data da última atividade do Copilot no Excel
  • Data da última atividade do Copilot no PowerPoint
  • Data da última atividade do Outlook Copilot
  • Data da última atividade do OneNote Copilot
  • Data da última atividade do Copilot no Loop
  • Período de Relatório

Os relatórios da versão 2 contêm todas as informações da versão 1, com as seguintes informações adicionais.

  • Prompts enviados para todos os aplicativos
  • Prompts enviados para o Copilot Chat (trabalho)
  • Prompts enviados para o Copilot Chat (web)
  • Dias de Uso Ativo para todos os aplicativos
  • Copilot Chat (trabalho) Data da Última Atividade
  • Copilot Chat (web) Data da Última Atividade
  • Data da última atividade do Microsoft 365 Copilot
  • Data da última atividade do Edge
  • Data da última atividade do agente do Copilot

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 código de 200 OK resposta e um fluxo no corpo da resposta. O conteúdo do fluxo é um arquivo CSV com o relatório solicitado.

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.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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

GET https://graph.microsoft.com/beta/copilot/reports/getMicrosoft365CopilotUsageUserDetail(period='D7')

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/octet-stream

Report Refresh Date,User Principal Name,Display Name,Last Activity Date,Copilot Chat Last Activity Date,Microsoft Teams Copilot Last Activity Date,Word Copilot Last Activity Date,Excel Copilot Last Activity Date,PowerPoint Copilot Last Activity Date,Outlook Copilot Last Activity Date,OneNote Copilot Last Activity Date,Loop Copilot Last Activity Date,Report Period
2026-07-03,E58EEF6A6BBD3D0293CB306D24A42057,6A4630397AAA1A9C8EED362168DC88A0,,,,,,,,,,7

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

{
  "value": [
    {
      "reportRefreshDate": "2025-08-20",
      "userPrincipalName": "DC8C64D6EC3A3AA17481D7E5EB5B68A6",
      "displayName": "C65E8D8AFA0DAB9639EDFAAEA94AFE66",
      "lastActivityDate": "2025-08-20",
      "copilotChatLastActivityDate": "2025-08-16",
      "microsoftTeamsCopilotLastActivityDate": "2025-08-20",
      "wordCopilotLastActivityDate": "2025-08-06",
      "excelCopilotLastActivityDate": "",
      "powerPointCopilotLastActivityDate": "2025-03-26",
      "outlookCopilotLastActivityDate": "",
      "oneNoteCopilotLastActivityDate": "",
      "loopCopilotLastActivityDate": "",
      "copilotActivityUserDetailsByPeriod": [
        {
          "reportPeriod": 7
        }
      ]
    }
  ]
}
  • Last updated on