Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Obtenga los datos de actividad más recientes para los usuarios habilitados de Microsoft 365 Copilot aplicaciones.
Esta API está disponible en las siguientes implementaciones nacionales de nube.
| Servicio global |
Gobierno de EE. UU. L4 |
Us Government L5 (DOD) |
China operada por 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
| Tipo de permiso |
Permisos con privilegios mínimos |
Permisos con privilegios más altos |
| Delegado (cuenta profesional o educativa) |
Reports.Read.All |
No disponible. |
| Delegado (cuenta personal de Microsoft) |
No admitida. |
No admitida. |
| Aplicación |
Reports.Read.All |
No disponible. |
Importante
Para que los permisos delegados permitan a las aplicaciones leer informes de uso del servicio en nombre de un usuario, el administrador de inquilinos debe haber asignado al usuario uno de los siguientes Microsoft Entra ID roles de administrador limitados:
- Administrador de la empresa
- Administrador de Exchange
- Administrador de SharePoint
- Administrador de Lync
- Administrador de servicios de Teams
- Administrador de comunicaciones de Teams
- Lector global
- Resumen de uso de Lector de informes
- Lector de informes
Para obtener más información, consulte Autorización para que las API lean los informes de uso de Microsoft 365.
Solicitud HTTP
GET /reports/getMicrosoft365CopilotUsageUserDetail(period='{period_value}')
Parámetros de función
En la dirección URL de la solicitud, proporcione los siguientes parámetros de consulta con valores.
| Parámetro |
Tipo |
Descripción |
| period |
Cadena |
Número de días anteriores en los que se va a notificar el uso agregado. Los valores admitidos son: , , , , ALLD180. D90D30D7 Los cuatro primeros valores siguen el formato Dn, donde n representa el número de días anteriores sobre los que se van a agregar datos.
ALL indica que se notifica el uso durante 7, 30, 90 y 180 días. |
Parámetros de consulta opcionales
Este método admite el $formatparámetro de consulta OData para personalizar la respuesta. El tipo de salida predeterminado es application/json. Sin embargo, si desea especificar el tipo de salida, puede usar el parámetro de consulta OData $format para establecer la salida predeterminada en text/csv o application/json.
Cuerpo de la solicitud
No proporcione un cuerpo de solicitud para este método.
Respuesta
CSV
Si se ejecuta correctamente, este método devuelve una respuesta 302 Found que redirige a una URL de descarga con autenticación previa para el informe. La URL se encuentra en el encabezado Location de la respuesta.
Las direcciones URL de descarga autenticadas previamente solo son válidas durante un breve período de tiempo (unos minutos) y no requieren un Authorization encabezado.
El archivo CSV tiene los siguientes encabezados de columna.
- Fecha de actualización del informe
- Período del informe
- Nombre principal de usuario
- Nombre para mostrar
- Fecha de la última actividad
- Fecha de última actividad de Copilot de Microsoft Teams
- Word fecha de la última actividad de Copilot
- Fecha de la última actividad de Copilot de Excel
- Fecha de última actividad de PowerPoint Copilot
- Fecha de la última actividad de Copilot de Outlook
- Fecha de la última actividad de OneNote Copilot
- Loop fecha de la última actividad de Copilot
- Fecha de última actividad del chat de Copilot
JSON
Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un objeto JSON en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: salida CSV
En el ejemplo siguiente se devuelve una dirección URL para un archivo CSV.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUsageUserDetail(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.GetMicrosoft365CopilotUsageUserDetailWithPeriod("{period}").GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Format = "text/csv";
});
mgc-beta reports get-microsoft365-copilot-usage-user-detail-with-period get --period {period-id}
// 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.ReportsGetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetQueryParameters{
Format: &requestFormat,
}
configuration := &graphreports.ReportsGetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetRequestConfiguration{
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().GetMicrosoft365CopilotUsageUserDetailWithPeriod(&period).Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
graphClient.reports().getMicrosoft365CopilotUsageUserDetailWithPeriod("{period}").get(requestConfiguration -> {
requestConfiguration.queryParameters.format = "text/csv";
});
const options = {
authProvider,
};
const client = Client.init(options);
let stream = await client.api('/reports/getMicrosoft365CopilotUsageUserDetail(period='D7')')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Reports\GetMicrosoft365CopilotUsageUserDetail(period='{period}')\GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetRequestConfiguration();
$queryParameters = GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->format = "text/csv";
$requestConfiguration->queryParameters = $queryParameters;
$graphServiceClient->reports()->getMicrosoft365CopilotUsageUserDetailWithPeriod('{period}', )->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Reports
Get-MgBetaReportMicrosoft365CopilotUsageUserDetail -Format "text/csv" -Period $periodId
# 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_usage_user_detail(period='{period}').get_microsoft365_copilot_usage_user_detail_with_period_request_builder import GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilder
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 = GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilder.GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetQueryParameters(
format = "text/csv",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
await graph_client.reports.get_microsoft365_copilot_usage_user_detail_with_period("{period}").get(request_configuration = request_configuration)
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe
El archivo CSV del Location encabezado de la respuesta 302 tiene el siguiente esquema.
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Report Refresh Date,Report Period,User Principal Name,Display Name,Last Activity Date,Microsoft Teams Copilot Last Activity Date,Word Copilot Last Activity Date,Excel Copilot Last Activity Date,PowerPoint Copilot Last Activity Date,Outlook Copilot Last Activity Date,OneNote Copilot Last Activity Date,Loop Copilot Last Activity Date,Copilot Chat Last Activity Date
Ejemplo 2: Salida JSON
En el ejemplo siguiente se devuelven datos JSON.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUsageUserDetail(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.GetMicrosoft365CopilotUsageUserDetailWithPeriod("{period}").GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Format = "application/json";
});
mgc-beta reports get-microsoft365-copilot-usage-user-detail-with-period get --period {period-id}
// 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.ReportsGetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetQueryParameters{
Format: &requestFormat,
}
configuration := &graphreports.ReportsGetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetRequestConfiguration{
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().GetMicrosoft365CopilotUsageUserDetailWithPeriod(&period).Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
graphClient.reports().getMicrosoft365CopilotUsageUserDetailWithPeriod("{period}").get(requestConfiguration -> {
requestConfiguration.queryParameters.format = "application/json";
});
const options = {
authProvider,
};
const client = Client.init(options);
let stream = await client.api('/reports/getMicrosoft365CopilotUsageUserDetail(period='D7')')
.version('beta')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Reports\GetMicrosoft365CopilotUsageUserDetail(period='{period}')\GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetRequestConfiguration();
$queryParameters = GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->format = "application/json";
$requestConfiguration->queryParameters = $queryParameters;
$graphServiceClient->reports()->getMicrosoft365CopilotUsageUserDetailWithPeriod('{period}', )->get($requestConfiguration)->wait();
Import-Module Microsoft.Graph.Beta.Reports
Get-MgBetaReportMicrosoft365CopilotUsageUserDetail -Format "application/json" -Period $periodId
# 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_usage_user_detail(period='{period}').get_microsoft365_copilot_usage_user_detail_with_period_request_builder import GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilder
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 = GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilder.GetMicrosoft365CopilotUsageUserDetailWithPeriodRequestBuilderGetQueryParameters(
format = "application/json",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
await graph_client.reports.get_microsoft365_copilot_usage_user_detail_with_period("{period}").get(request_configuration = request_configuration)
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 10747
{
"@odata.nextLink": "https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUsageUserDetail(period='D7')?$format=application/json&$skiptoken=MDoyOg",
"value": [
{
"reportRefreshDate": "2024-08-20",
"userPrincipalName": "DC8C64D6EC3A3AA17481D7E5EB5B68A6",
"displayName": "C65E8D8AFA0DAB9639EDFAAEA94AFE66",
"lastActivityDate": "2024-08-20",
"copilotChatLastActivityDate": "2024-08-16",
"microsoftTeamsCopilotLastActivityDate": "2024-08-20",
"wordCopilotLastActivityDate": "2024-08-06",
"excelCopilotLastActivityDate": "",
"powerPointCopilotLastActivityDate": "2024-03-26",
"outlookCopilotLastActivityDate": "",
"oneNoteCopilotLastActivityDate": "",
"loopCopilotLastActivityDate": "",
"copilotActivityUserDetailsByPeriod": [
{
"reportPeriod": 7
}
]
}
]
}