reportRoot: getMicrosoft365CopilotUserCountSummary

Artikel
09/24/2024

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 aggregierte Anzahl der aktiven und aktivierten Benutzer von Microsoft 365 Copilot für einen angegebenen Zeitraum ab.

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.

Damit apps dienstverwendungsberichte im Namen eines Benutzers lesen können, muss der Mandantenadministrator dem Benutzer eine der folgenden Microsoft Entra ID eingeschränkten Administratorrollen zugewiesen haben:

Unternehmensadministrator
Exchange-Administrator
SharePoint-Administrator
Lync-Administrator
Teams-Dienstadministrator
Teams-Kommunikationsadministrator
Globaler Leser
Leseberechtigter für Verwendungszusammenfassungsberichte
Berichteleser

Weitere Informationen finden Sie unter Autorisierung für APIs zum Lesen von Microsoft 365-Nutzungsberichten.

HTTP-Anforderung

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

Funktionsparameter

Stellen Sie in der URL der Anforderung die folgenden Abfrageparameter mit Werten bereit.

Parameter	Typ	Beschreibung
Zeitraum	Zeichenfolge	Die Anzahl der vorherigen Tage, über die die aggregierte Nutzung gemeldet werden soll. Die unterstützten Werte sind: `D7`, `D30`, `D90`, `D180`, `ALL`. Die ersten vier Werte folgen dem Format Dn, wobei n die Anzahl der Tage darstellt, über die Daten aggregiert werden sollen. `ALL` gibt an, dass die Nutzung für 7, 30, 90 und 180 Tage gemeldet wird.

Optionale Abfrageparameter

Diese Methode unterstützt den $formatOData-Abfrageparameter , um die Antwort anzupassen. Der Standardausgabetyp ist application/json. 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 Kopfzeilen für Spalten.

Berichtsaktualisierungsdatum
Berichtszeitraum
Alle App-aktivierten Benutzer
Alle aktiven App-Benutzer
Microsoft Teams-fähige Benutzer
Aktive Microsoft Teams-Benutzer
Word Aktivierte Benutzer
aktive Benutzer Word
PowerPoint-fähige Benutzer
Aktive PowerPoint-Benutzer
Outlook-aktivierte Benutzer
Aktive Outlook-Benutzer
Excel-fähige Benutzer
Aktive Excel-Benutzer
OneNote-aktivierte Benutzer
Aktive OneNote-Benutzer
Loop Aktivierte Benutzer
aktive Benutzer Loop
Copilot Chat-aktivierte Benutzer
Copilot Chat Aktive Benutzer

JSON

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

Beispiele

Beispiel 1: CSV-Ausgabe

Im folgenden Beispiel wird eine URL für eine CSV-Datei ausgegeben.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetMicrosoft365CopilotUserCountSummaryWithPeriod("{period}").GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Format = "text/csv";
});

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



mgc-beta reports get-microsoft365-copilot-user-count-summary-with-period get --period {period-id}

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphreports "github.com/microsoftgraph/msgraph-beta-sdk-go/reports"
	  //other-imports
)


requestFormat := "text/csv"

requestParameters := &graphreports.ReportsGetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetQueryParameters{
	Format: &requestFormat,
}
configuration := &graphreports.ReportsGetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
period := "{period}"
graphClient.Reports().GetMicrosoft365CopilotUserCountSummaryWithPeriod(&period).Get(context.Background(), configuration)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getMicrosoft365CopilotUserCountSummaryWithPeriod("{period}").get(requestConfiguration -> {
	requestConfiguration.queryParameters.format = "text/csv";
});

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getMicrosoft365CopilotUserCountSummary(period='D7')')
	.version('beta')
	.get();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Reports\GetMicrosoft365CopilotUserCountSummary(period='{period}')\GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetRequestConfiguration();
$queryParameters = GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->format = "text/csv";
$requestConfiguration->queryParameters = $queryParameters;


$graphServiceClient->reports()->getMicrosoft365CopilotUserCountSummaryWithPeriod('{period}', )->get($requestConfiguration)->wait();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


Import-Module Microsoft.Graph.Beta.Reports

Get-MgBetaReportMicrosoft365CopilotUserCountSummary -Format "text/csv"  -Period $periodId

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.reports.get_microsoft365_copilot_user_count_summary(period='{period}').get_microsoft365_copilot_user_count_summary_with_period_request_builder import GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilder.GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetQueryParameters(
		format = "text/csv",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

await graph_client.reports.get_microsoft365_copilot_user_count_summary_with_period("{period}").get(request_configuration = request_configuration)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Die CSV-Datei im Location Header der Antwort 302 weist das folgende Schema auf.

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

Beispiel 2: JSON-Ausgabe

Im folgenden Beispiel werden JSON-Daten zurückgegeben.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetMicrosoft365CopilotUserCountSummaryWithPeriod("{period}").GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Format = "application/json";
});

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



mgc-beta reports get-microsoft365-copilot-user-count-summary-with-period get --period {period-id}

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphreports "github.com/microsoftgraph/msgraph-beta-sdk-go/reports"
	  //other-imports
)


requestFormat := "application/json"

requestParameters := &graphreports.ReportsGetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetQueryParameters{
	Format: &requestFormat,
}
configuration := &graphreports.ReportsGetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
period := "{period}"
graphClient.Reports().GetMicrosoft365CopilotUserCountSummaryWithPeriod(&period).Get(context.Background(), configuration)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getMicrosoft365CopilotUserCountSummaryWithPeriod("{period}").get(requestConfiguration -> {
	requestConfiguration.queryParameters.format = "application/json";
});

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getMicrosoft365CopilotUserCountSummary(period='D7')')
	.version('beta')
	.get();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Reports\GetMicrosoft365CopilotUserCountSummary(period='{period}')\GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetRequestConfiguration();
$queryParameters = GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->format = "application/json";
$requestConfiguration->queryParameters = $queryParameters;


$graphServiceClient->reports()->getMicrosoft365CopilotUserCountSummaryWithPeriod('{period}', )->get($requestConfiguration)->wait();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


Import-Module Microsoft.Graph.Beta.Reports

Get-MgBetaReportMicrosoft365CopilotUserCountSummary -Format "application/json"  -Period $periodId

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.reports.get_microsoft365_copilot_user_count_summary(period='{period}').get_microsoft365_copilot_user_count_summary_with_period_request_builder import GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilder.GetMicrosoft365CopilotUserCountSummaryWithPeriodRequestBuilderGetQueryParameters(
		format = "application/json",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

await graph_client.reports.get_microsoft365_copilot_user_count_summary_with_period("{period}").get(request_configuration = request_configuration)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

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

Freigeben über

reportRoot: getMicrosoft365CopilotUserCountSummary

Berechtigungen

HTTP-Anforderung

Funktionsparameter

Optionale Abfrageparameter

Anforderungsheader

Anforderungstext

Antwort

CSV

JSON

Beispiele

Beispiel 1: CSV-Ausgabe

Anforderung

Antwort

Beispiel 2: JSON-Ausgabe

Anforderung

Antwort

Feedback

Zusätzliche Ressourcen