cloudPcReports: getDailyAggregatedRemoteConnectionReports

Namespace: microsoft.graph

Important

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 daily aggregated remote connection reports, such as round trip time, available bandwidth, and so on, in a given period.

This API is available in the following national cloud deployments.

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

Permissions

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) CloudPC.Read.All CloudPC.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application CloudPC.Read.All CloudPC.ReadWrite.All

HTTP request

POST /deviceManagement/virtualEndpoint/reports/getDailyAggregatedRemoteConnectionReports

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Parameter Type Description
filter String OData filter syntax. Supported filters include and, or, lt, le, gt, ge and eq.
select String collection OData select syntax. Represents the selected columns of the reports.
search String Specifies a string to search
groupBy String collection Specify how to group the reports. If used, must have the same contents as select parameter
orderBy String collection Specify how to sort the reports.
skip Int32 Number of records to skip.
top Int32 The number of top records to return.

Response

If successful, this action returns a 200 OK response code and a Stream in the response body.

Examples

Request

The following is an example of a request.

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getDailyAggregatedRemoteConnectionReports
Content-Type: application/json
Content-length: 199

{
    "filter" : "CloudPcId eq '5db15afe-025d-4f1b-b43a-d0554b63ffff' and RoundTripTimeInMsP50 lt 100 and EventDateTime gt 2022-06-01 ", 
    "search" : "abc0907", 
    "select" : ["EventDateTime", "CloudPcId", "ManagedDeviceName", "UsageInHour", "RoundTripTimeInMsP50", "AvailableBandwidthInMBpsP50", "RemoteSignInTimeInSecP50", "UserPrincipalName"],
    "skip": "0",
    "top": "25"
}

Response

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/octet-stream

{
    "TotalRowCount": 1,
    "Schema": [
        {
            "Column": "UsageInHour",
            "PropertyType": "Double"
        },
        {
            "Column": "RoundTripTimeInMsP50",
            "PropertyType": "Double"
        },
        {
            "Column": "RemoteSignInTimeInSecP50",
            "PropertyType": "Double"
        },
        {
            "Column": "AvailableBandwidthInMBpsP50",
            "PropertyType": "Double"
        },
        {
            "Column": "EventDateTime",
            "PropertyType": "DateTime"
        }
    ],
    "Values": [
        [
            16.310277777777777,
            393.0,
            9.088,
            1.423828125,
            "2022-09-15T00:00:00"
        ]
    ]
}