reports: webCategoryReport

Namespace: microsoft.graph.networkaccess

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 number of users, devices, and transactions for destination URLs, grouped by web category.

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

To read the configuration, the calling user must also be assigned at least one of the following Microsoft Entra roles.

• Global Reader
• Global Secure Access Administrator
• Security Administrator

HTTP request

GET /networkAccessRoot/reports/webCategoryReport(startDateTime={startDateTime},endDateTime={endDateTime})

Function parameters

In the request URL, provide the following query parameters with values. The following table shows the parameters that can be used with this function.

Parameter	Type	Description
startDateTime	DateTimeOffset	The date and time when the reporting period begins.
endDateTime	DateTimeOffset	The date and time when the reporting period ends.

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.

Response

If successful, this function returns a 200 OK response code and a microsoft.graph.networkaccess.webCategoriesSummary collection in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/networkaccess/reports/webCategoriesReport(startDateTime=2023-08-20T12:12:59.076Z, endDateTime=2023-08-21T12:12:59.076Z) 

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

{
 "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.networkaccess.webCategoriesSummary)",
 "value": [
   {
     "webCategory": {
       "displayName": "Arts",
       "name": "arts",
       "group": "general surfing"
     },
     "userCount": 10,
     "deviceCount": 12,
     "transactionCount": 100
   }
 ]
}