Partager via


reportRoot : getMicrosoft365CopilotUserCountSummary

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenez le nombre agrégé d’utilisateurs actifs et activés de Microsoft 365 Copilot pour une période spécifiée.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Reports.Read.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Reports.Read.All Non disponible.

Importante

Pour que les autorisations déléguées permettent aux applications de lire les rapports d’utilisation du service au nom d’un utilisateur, l’administrateur client doit avoir attribué à l’utilisateur l’un des rôles d’administrateur limités Microsoft Entra ID suivants :

  • Administrateur de la société
  • Administrateur Exchange
  • Administrateur SharePoint
  • Administrateur Lync
  • Administrateur du service Teams
  • Administrateur des communications Teams
  • Lecteur général
  • Lecteur Rapports de synthèse de l’utilisation
  • Lecteur de rapports

Pour plus d’informations, consultez Autorisation pour les API de lire les rapports d’utilisation de Microsoft 365.

Requête HTTP

GET /reports/getMicrosoft365CopilotUserCountSummary(period='{period_value}')

Paramètres de fonction

Dans l’URL de la demande, indiquez les paramètres de requête suivants avec leurs valeurs.

Paramètre Type Description
point String Nombre de jours précédents pendant lesquels signaler l’utilisation agrégée. Les valeurs prises en charge sont : D7, D30, ALLD90D180. Les quatre premières valeurs suivent le format Dn où n représente le nombre de jours pendant lesquels agréger les données. ALL indique de signaler l’utilisation pendant 7, 30, 90 et 180 jours.

Paramètres facultatifs de la requête

Cette méthode prend en charge le $formatparamètre de requête OData pour personnaliser la réponse. Le type de sortie par défaut est application/json. Toutefois, si vous souhaitez spécifier le type de sortie, vous pouvez utiliser le paramètre de requête OData $format pour définir la sortie par défaut sur text/csv ou application/json.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

CSV

Si elle réussit, cette méthode renvoie une réponse 302 Found qui redirige vers une URL de téléchargement préalablement authentifiée pour le rapport. Cette URL est accessible dans l’en-tête Location de la réponse.

Les URL de téléchargement pré-authentifiées ne sont valides que pendant une courte période (quelques minutes) et ne nécessitent pas d’en-tête Authorization .

Le fichier CSV comporte les en-têtes de colonnes suivants.

  • Date d’actualisation du rapport
  • Période du rapport
  • Tous les utilisateurs prenant en charge l’application
  • Tous les utilisateurs actifs de l’application
  • Utilisateurs avec Microsoft Teams
  • Utilisateurs actifs de Microsoft Teams
  • Utilisateurs Word activés
  • Word utilisateurs actifs
  • Utilisateurs avec PowerPoint
  • Utilisateurs actifs PowerPoint
  • Utilisateurs avec Outlook
  • Utilisateurs actifs Outlook
  • Utilisateurs avec Excel
  • Utilisateurs actifs Excel
  • Utilisateurs avec OneNote
  • Utilisateurs actifs OneNote
  • Utilisateurs Loop activés
  • Loop utilisateurs actifs
  • Utilisateurs copilot chat activés
  • Utilisateurs actifs de Copilot Chat

JSON

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet JSON dans le corps de la réponse.

Exemples

Exemple 1 : sortie CSV

L’exemple suivant génère une URL pour un fichier CSV.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

Le fichier CSV dans l’en-tête Location de la réponse 302 a le schéma suivant.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,Report Period,Any App Enabled Users,Any App Active Users,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,Copilot Chat Enabled Users,Copilot Chat Active Users

Exemple 2 : sortie JSON

L’exemple suivant retourne des données JSON.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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

{
    "value": [
        {
            "reportRefreshDate": "2024-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
                }
            ]
        }
    ]
}