Partager via

reportRoot : getTeamsTeamActivityCounts

  • Article

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 d’activités d’équipe dans Microsoft Teams. Les types d’activités sont liés aux réunions et aux messages.

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.

Note: 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 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/getTeamsTeamActivityCounts(period='{period_value}')

Paramètres de fonction

Dans l’URL de la requête, fournissez les paramètres suivants avec une valeur valide.

Paramètre Type Description
point string Spécifie la durée de regroupement du rapport. Les valeurs prises en charge pour {period_value} sont : D7, D30, D90et D180. Ces valeurs suivent le format Dn, où n représente le nombre de jours pendant lesquels le rapport est regroupé. Obligatoire.
date Date Spécifie la date à laquelle vous souhaitez afficher des détails sur les activités au sein des équipes. La valeur {date_value} doit suivre le format AAAA-MM-JJ. Sachant que ce rapport est disponible uniquement pour les 30 derniers jours, la valeur {date_value} doit être comprise dans cette plage.

Note: Vous devez définir la période ou la date dans l’URL de la demande.

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 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

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

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
  • Période du rapport
  • Date du rapport
  • Utilisateurs actifs
  • Canaux actifs
  • Invités
  • Réactions
  • Réunions organisées
  • Publier des messages
  • Messages de canal
  • Canaux partagés actifs
  • Utilisateurs externes actifs
  • Messages de réponse
  • Messages urgents
  • Mentions

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

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

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/reports/getTeamsTeamActivityCounts(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

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,Report Period,Report Date,Active Users,Active Channels,Guests,Reactions,Meetings Organized,Post Messages,Channel Messages,Active Shared Channels,Active External Users,Reply Messages,Urgent Messages,Mentions

Exemple 2 : sortie JSON

Voici un exemple qui retourne JSON.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la 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: 641

{
  "@odata.context": "https://graph.microsoft.com/beta/reports/getTeamsTeamActivityCounts(period='D7')?$format=application/json&$skiptoken=D07uj", 
  "value": [
    {
      "reportRefreshDate": "2021-09-01", 
      "reportPeriod":7,
      "userCounts": [
        {
          "reportDate": "2021-09-01", 
          "activeUsers": 26, 
          "activeChannels": 17, 
          "guests": 4, 
          "reactions": 36, 
          "meetingsOrganized": 0,
          "postMessages": 83,
          "channelMessages": 101,
          "activeSharedChannels": 1,
          "activeExternalUsers": 2,
          "replyMessages":10,
          "urgentMessages":8,
          "mentions":1
        }
      ]
    }
  ]
}