reportRoot: getTeamsTeamCounts

Namespace: microsoft.graph


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get the number of teams of a particular type in an instance of Microsoft Teams.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Reports.Read.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Reports.Read.All Not available.

Note: For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more information, see Authorization for APIs to read Microsoft 365 usage reports.

HTTP request

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

Function parameters

In the request URL, provide the following parameters with a valid value.

Parameter Type Description
period string Specifies the length of time over which the report is aggregated. The supported values for {period_value} are: D7, D30, D90, and D180. These values follow the format Dn, where n represents the number of days over which the report is aggregated. Required.

Note: You need to set either period or date in the request URL.

Optional query parameters

This method supports the $format OData query parameter to customize the response. The default output type is text/csv. However, if you want to specify the output type, you can use the OData $format query parameter to set the default output to text/csv or application/json.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.



If successful, this method returns a 302 Found response that redirects to a pre-authenticated download URL for the report. That URL can be found in the Location header in the response.

Pre-authenticated download URLs are only valid for a short period (a few minutes) and don't require an Authorization header.

The CSV file has the following headers for columns:

  • Report Refresh Date
  • Report Date
  • Public Teams
  • Active Public Teams
  • Private Teams
  • Active Private Teams


If successful, this method returns a 200 OK response code and a JSON object in the response body.


Example 1: CSV output

Here's an example that outputs CSV.


The following example shows a request.



The following example shows the response.

HTTP/1.1 302 Found
Content-Type: text/plain

Follow the 302 redirection and the CSV file that downloads have the following schema.

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Report Refresh Date,Report Date,Public Teams,Active Public Teams,Private Teams,Active Private Teams,

Example 2: JSON output

Here's an example that returns JSON.


The following example shows a request.



The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 641
  "@odata.context": "'D7')?$format=application/json&$skiptoken=D07uj", 
  "value": [
      "reportRefreshDate": "2021-09-01", 
      "teamsTeamUsageByDate": [
          "reportDate": "2022-08-01", 
          "publicTeams": 26, 
          "privateTeams": 17, 
          "activePublicTeams": 20, 
          "activePrivateTeams": 12