copilotReportRoot: getMicrosoft365CopilotUserCountSummary

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 o número agregado de usuários ativos e habilitados do Microsoft 365 Copilot por um período de tempo especificado.

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 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 Global
  • Leitor de relatórios de resumo do uso
  • 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/getMicrosoft365CopilotUserCountSummary(period={period}, version={version})

GET https://graph.microsoft.com/beta/copilot/reports/getMicrosoft365CopilotUserCountSummary(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. O valor com suporte é v2 (padrão).

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
  • Período de Relatório
  • Usuários habilitados para o Microsoft Teams
  • Usuários ativos do Microsoft Teams
  • Usuários habilitados para o Word
  • Usuários ativos do Word
  • Usuários habilitados para PowerPoint
  • Usuários Ativos do PowerPoint
  • Usuários habilitados para o Outlook
  • Usuários Ativos do Outlook
  • Usuários habilitados para Excel
  • Usuários Ativos do Excel
  • Usuários habilitados para o OneNote
  • Usuários Ativos do OneNote
  • Usuários Habilitados para Loop
  • Loop de usuários ativos
  • Qualquer aplicativo Usuários habilitados
  • Qualquer usuário ativo do aplicativo
  • Usuários habilitados para Copilot Chat
  • Usuários ativos do Copilot Chat

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

  • Usuários habilitados para Edge
  • Usuários Ativos do Edge
  • Usuários habilitados para o Microsoft 365 Copilot
  • Usuários ativos do Microsoft 365 Copilot
  • Usuários habilitados para o Copilot Chat (trabalho)
  • Copilot Chat (trabalho) Usuários ativos
  • Usuários habilitados para o Copilot Chat (web)
  • Usuários ativos do Copilot Chat (web)
  • Total de prompts enviados
  • Média de prompts enviados

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/getMicrosoft365CopilotUserCountSummary(period='D7')?$format=application/json

GET https://graph.microsoft.com/beta/copilot/reports/getMicrosoft365CopilotUserCountSummary(period='D7')?$format=application/json

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,Report Period,Microsoft Teams Enabled Users,Microsoft Teams Active Users,Word Enabled Users,Word Active Users,PowerPoint Enabled Users,PowerPoint Active Users,Outlook Enabled Users,Outlook Active Users,Excel Enabled Users,Excel Active Users,OneNote Enabled Users,OneNote Active Users,Loop Enabled Users,Loop Active Users,Any App Enabled Users,Any App Active Users,Copilot Chat Enabled Users,Copilot Chat Active Users
2026-07-03,7,25,0,25,0,25,0,25,0,25,0,25,0,25,0,25,0,25,0

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

{
  "value": [
    {
      "reportRefreshDate": "2025-08-20",
      "adoptionByProduct": [
        {
          "reportPeriod": 7,
          "anyAppEnabledUsers": 359229,
          "anyAppActiveUsers": 165115,
          "microsoftTeamsEnabledUsers": 359096,
          "microsoftTeamsActiveUsers": 123341,
          "wordEnabledUsers": 359096,
          "wordActiveUsers": 21459,
          "powerPointEnabledUsers": 359096,
          "powerPointActiveUsers": 8530,
          "outlookEnabledUsers": 359096,
          "outlookActiveUsers": 37270,
          "excelEnabledUsers": 359096,
          "excelActiveUsers": 6709,
          "oneNoteEnabledUsers": 359096,
          "oneNoteActiveUsers": 1660,
          "loopEnabledUsers": 359096,
          "loopActiveUsers": 1345,
          "copilotChatEnabledUsers": 359096,
          "copilotChatActiveUsers": 65480
        }
      ]
    }
  ]
}
  • Última atualização a