Documentation

GET /service/api/console/gsm/{gsmKey}/dnsp/trafficsummary/categoryuserreport
?startDate={startDate}
&endDate={endDate}
&categories={categories}

Returns a traffic summary (e.g. the number of blocked DNS requests, allowed DNS requests, and user name) grouped by categories and users for a given GSM.

NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required
startDate	If specified, returns DNS traffic summary after (or at) the given date. If omitted, defaults to 'endDate' minus 24 hours.	date	None.
endDate	If specified, returns DNS traffic summary before (or at) the given date. If omitted, defaults to the current date and time.	date	None.
categories	A comma separated list of one or more DNS Protection category identifiers (e.g. 14,47,81). Call 'get categories' to get a list of available DNS Protection categories and their respective identifiers. If omitted, defaults to all categories.	string	None.

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/6731-D9D6-8417-48C6-87A2/dnsp/trafficsummary/categoryuserreport?startDate=2024-08-08T18:58:18.7362399Z&endDate=2024-09-07T18:58:18.7362399Z&categories=42,7,55

Body Parameters

None.

Response Information

Resource Description

Traffic summary category user report for a specific GSM site.

GetDNSPTrafficCategoryUserSummaryResponseModel

Name	Description	Type	Additional Information
StartDate	Start date for returned records. Traffic summary records after (or at) this date are contained in the response.	date	None.
EndDate	End date for returned records. Traffic summary records before (or at) this date are contained in the response.	date	None.
Records	A list of DNSP traffic category summary records.	Collection of GetDNSPTrafficCategoryUserSummaryResponseModelRecord	None.

Sample Response

{
  "StartDate": "2024-09-07T03:19:28.9604218Z",
  "EndDate": "2024-09-08T03:19:28.9604218Z",
  "Records": [
    {
      "CategoryId": 2,
      "Users": [
        {
          "UserName": "User1",
          "AllowedDNSRequests": 12306,
          "BlockedDNSRequests": 1862
        },
        {
          "UserName": "User2",
          "AllowedDNSRequests": 14099,
          "BlockedDNSRequests": 1129
        }
      ]
    },
    {
      "CategoryId": 3,
      "Users": [
        {
          "UserName": "User1",
          "AllowedDNSRequests": 12341,
          "BlockedDNSRequests": 2758
        },
        {
          "UserName": "User2",
          "AllowedDNSRequests": 12518,
          "BlockedDNSRequests": 1832
        }
      ]
    }
  ]
}

<GetDNSPTrafficCategoryUserSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.DNSProtection">
  <EndDate>2024-09-08T03:19:28.9604218Z</EndDate>
  <Records>
    <GetDNSPTrafficCategoryUserSummaryResponseModelRecord>
      <CategoryId>2</CategoryId>
      <Users>
        <GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
          <AllowedDNSRequests>12306</AllowedDNSRequests>
          <BlockedDNSRequests>1862</BlockedDNSRequests>
          <UserName>User1</UserName>
        </GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
        <GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
          <AllowedDNSRequests>14099</AllowedDNSRequests>
          <BlockedDNSRequests>1129</BlockedDNSRequests>
          <UserName>User2</UserName>
        </GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
      </Users>
    </GetDNSPTrafficCategoryUserSummaryResponseModelRecord>
    <GetDNSPTrafficCategoryUserSummaryResponseModelRecord>
      <CategoryId>3</CategoryId>
      <Users>
        <GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
          <AllowedDNSRequests>12341</AllowedDNSRequests>
          <BlockedDNSRequests>2758</BlockedDNSRequests>
          <UserName>User1</UserName>
        </GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
        <GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
          <AllowedDNSRequests>12518</AllowedDNSRequests>
          <BlockedDNSRequests>1832</BlockedDNSRequests>
          <UserName>User2</UserName>
        </GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
      </Users>
    </GetDNSPTrafficCategoryUserSummaryResponseModelRecord>
  </Records>
  <StartDate>2024-09-07T03:19:28.9604218Z</StartDate>
</GetDNSPTrafficCategoryUserSummaryResponseModel>

GET /service/api/console/gsm/{gsmKey}/dnsp/trafficsummary/categoryuserreport ?startDate={startDate} &endDate={endDate} &categories={categories}