cloudPcReports: retrieveConnectionQualityReports

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 overall connection quality reports for all devices in the current tenant. This includes the regional connection quality trend report, and the regional connection quality insight report, including round trip time, available bandwidth, UPD usage, and drop connections.

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.

|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/retrieveConnectionQualityReports

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
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.
groupBy	String collection	Specifies how to group the reports. If used, must have the same contents as the select parameter.
orderBy	String collection	Specifies how to sort the reports.
search	String	Specifies a String to search.
select	String collection	OData $select syntax. The selected columns of the reports.
skip	Int32	The 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 example shows a request.

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

{
    "reportName":"regionalConnectionQualityTrendReport",
    "filter": "",
    "select": ["GatewayRegion", "RoundTripTimeTrend", "AvailableBandwidthTrend", "UDPUtilizationTrend", "DroppedConnectionTrend", "WeeklyAvgRoundTripTimeInMs", "DailyAvgRoundTripTimeInMs", "WeeklyAvailableBandwidthInMbps", "DailyAvailableBandwidthInMbps", "WeeklyUdpUtilization", "DailyWeeklyUdpUtilization", "WeeklyDroppedConnectionsCount", "DailyDroppedConnectionsCount"],
    "search": "",
    "skip": 0,
    "top": 50
}

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": 2,
    "Schema": [
        {
            "Column": "GatewayRegion",
            "PropertyType": "String"
        },
        {
            "Column": "RoundTripTimeTrend",
            "PropertyType": "String"
        },
        {
            "Column": "AvailableBandwidthTrend",
            "PropertyType": "String"
        },
        {
            "Column": "UDPUtilizationTrend",
            "PropertyType": "String"
        },
        {
            "Column": "DroppedConnectionTrend",
            "PropertyType": "String"
        },
        {
            "Column": "WeeklyAvgRoundTripTimeInMs",
            "PropertyType": "Double"
        },
        {
            "Column": "DailyAvgRoundTripTimeInMs",
            "PropertyType": "Double"
        },
        {
            "Column": "WeeklyAvailableBandwidthInMbps",
            "PropertyType": "Double"
        },
        {
            "Column": "DailyAvailableBandwidthInMbps",
            "PropertyType": "Double"
        },
        {
            "Column": "WeeklyUdpUtilization",
            "PropertyType": "Double"
        },
        {
            "Column": "DailyWeeklyUdpUtilization",
            "PropertyType": "Double"
        },
        {
            "Column": "WeeklyDroppedConnectionsCount",
            "PropertyType": "Int32"
        },
        {
            "Column": "DailyDroppedConnectionsCount",
            "PropertyType": "Int32"
        }
    ],
    "Values" :[
        ["Japan East", "Increasing", "Decreasing", "Static", "Decreasing", "296.25", "350.50", "3.1", "2,1", "51.2", "47.8", "19", "29"],
        ["Southeast Asia", "Decreasing", "Static", "Increasing", "Increasing", "337.14", "299.50", "1.7", "2,2", "33.5", "67.8", "17", "16"],
    ]
}