reportRoot : getTeamsUserActivityTotalDistributionCounts

Espace de noms: microsoft.graph

Obtenez le nombre d’activités utilisateur Microsoft Teams sur la période sélectionnée. Les types d’activité sont les messages de conversation d’équipe, les messages de conversation privée, les appels, les réunions, les réunions organisées, les réunions suivies, la durée audio, la durée vidéo, la durée du partage d’écran, la publication de messages et les messages de réponse.

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

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.

Remarque : Pour que les autorisations déléguées permettent aux applications de lire les rapports d’utilisation du service pour le compte d’un utilisateur, l’administrateur client doit avoir attribué à l’utilisateur le rôle d’administrateur limité d’ID Microsoft Entra approprié. Pour plus d’informations, consultez Autorisation pour les API de lire les rapports d’utilisation de Microsoft 365.

Requête HTTP

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

Paramètres de fonction

Dans l’URL de la requête, indiquez une valeur valide pour le paramètre suivant.

Paramètres facultatifs de la requête

Cette méthode prend en charge les $formatparamètres de requête OData , $topet $skipToken pour personnaliser la réponse. Le type de sortie par défaut est text/csv. 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

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 colonne suivants :

• Date d’actualisation du rapport
• Messages de conversation d’équipe
• Messages de conversation privés
• Appels
• Réunions
• Réunions organisées
• Réunions suivies
• Durée audio
• Durée de la vidéo
• Durée du partage d’écran
• Publier des messages
• Messages de réponse
• Période du rapport

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.

La taille de page par défaut pour cette demande est de 2 000 éléments.

Exemples

Exemple 1 : sortie CSV

Voici un exemple qui génère des fichiers CSV.

Demande

Voici un exemple de demande.

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

Réponse

Voici un exemple de réponse.

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

Suivez la redirection 302 et le fichier CSV téléchargé a le schéma suivant.

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

Report Refresh Date,Team Chat Messages,Private Chat Messages,Calls,Meetings,Meetings Organized,Meetings Attended,Audio Duration,Video Duration,Screen Share Duration,Post Messages,Reply Messages,Report Period

Exemple 2 : sortie JSON

Voici un exemple qui retourne JSON.

Demande

Voici un exemple de demande.

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

Réponse

Voici un exemple de réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/getTeamsUserActivityTotalDistributionCounts(period='D7')?$format=application/json&$skiptoken=D07uj", 
  "value": [
      "reportRefreshDate": "2021-09-01", 
      "userCounts"
        {
          "reportPeriod":7,
          "teamChatMessages": 26, 
          "privateChatMessages": 17, 
          "calls": 4, 
          "meetings": 0, 
          "audioDuration": 00:00:00,
          "videoDuration": 00:00:00,
          "screenShareDuration": 00:00:00,
          "meetingsOrganized": 0,
          "meetingsAttended": 0,
          "postMessages": 1,
          "replyMessages": 1
    }
  ]
}