reportRoot: getTeamsUserActivityTotalDistributionCounts

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Ruft die Anzahl der Microsoft Teams-Benutzeraktivitäten im ausgewählten Zeitraum ab. Die Aktivitätstypen sind Teamchatnachrichten, private Chatnachrichten, Anrufe, Besprechungen, besprechungsorganisierte Besprechungen, teilnahmen, Audiodauer, Videodauer, Bildschirmfreigabedauer, Posten von Nachrichten und Antwortnachrichten.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	✅	✅	✅

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp	Berechtigungen mit den geringsten Berechtigungen	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	Reports.Read.All	Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt	Nicht unterstützt
Anwendung	Reports.Read.All	Nicht verfügbar.

Hinweis: Damit Apps mit delegierten Berechtigungen Dienstnutzungsberichte im Namen eines Benutzers lesen können, muss der Mandantenadministrator dem Benutzer die entsprechende Microsoft Entra ID eingeschränkte Administratorrolle zugewiesen haben. Weitere Informationen finden Sie unter Autorisierung für APIs zum Lesen von Microsoft 365-Nutzungsberichten.

HTTP-Anforderung

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

Funktionsparameter

Geben Sie in der Anforderungs-URL den folgenden Parameter mit einem gültigen Wert an.

Parameter	Typ	Beschreibung
Zeitraum	Zeichenfolge	Gibt die Zeitspanne an, für die der Bericht aggregiert wird. Die unterstützten Werte für {period_value} sind: D7, D30, D90und D180. Diese Werte folgen dem Format Dn, wobei n die Anzahl der Tage angibt, für die der Bericht aggregiert wird. Erforderlich.

Optionale Abfrageparameter

Diese Methode unterstützt die $formatOData-Abfrageparameter , $topund $skipToken zum Anpassen der Antwort. Der Standardausgabetyp ist text/csv. Wenn Sie jedoch den Ausgabetyp angeben möchten, können Sie den OData-Abfrageparameter $format verwenden, um die Standardausgabe auf text/csv oder application/jsonfestzulegen.

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

CSV

Wenn diese Methode erfolgreich ist, wird eine 302 Found-Antwort zurückgegeben, die zu einer vorauthentifizierten Download-URL für den Bericht umleitet. Die URL finden Sie in der Location-Kopfzeile der Antwort.

UrLs für vorab authentifizierte Downloads sind nur für einen kurzen Zeitraum (einige Minuten) gültig und erfordern Authorization keinen Header.

Die CSV-Datei verfügt über die folgenden Spaltenheader:

• Berichtsaktualisierungsdatum
• Team-Chatnachrichten
• Private Chatnachrichten
• Anrufe
• Besprechungen
• Besprechungen organisiert
• Besprechungen besucht
• Audiodauer
• Videodauer
• Bildschirmfreigabedauer
• Posten von Nachrichten
• Antworten auf Nachrichten
• Berichtszeitraum

JSON

Wenn die Methode erfolgreich verläuft, werden der 200 OK Antwortcode und ein JSON-Objekt im Antworttext zurückgegeben.

Die Standardseitengröße für diese Anforderung beträgt 2.000 Elemente.

Beispiele

Beispiel 1: CSV-Ausgabe

Hier sehen Sie ein Beispiel für die Ausgabe von CSV.

Anforderung

Hier sehen Sie ein Beispiel für die Anforderung.

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

Antwort

Hier ist ein Beispiel für die Antwort.

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

Befolgen Sie die 302-Umleitung, und die CSV-Datei, die heruntergeladen wird, hat das folgende Schema.

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

Beispiel 2: JSON-Ausgabe

Hier sehen Sie ein Beispiel, das JSON zurückgibt.

Anforderung

Hier sehen Sie ein Beispiel für die Anforderung.

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

Antwort

Hier ist ein Beispiel für die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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