Documentation

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

Returns a traffic summary (e.g. the number of total DNS requests, blocked DNS requests, and risky DNS requests) for each site under 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.

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/5811-21B8-34C3-41AA-B5A9/dnsp/trafficsummary?startDate=2023-01-09T17:49:15.3688718Z&endDate=2023-02-08T17:49:15.3688718Z

Body Parameters

None.

Response Information

Resource Description

Traffic summary information for GSM sites.

GetDNSPTrafficSummaryResponseModel

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.
Sites	The list of sites.	Collection of GetDNSPTrafficSummaryResponseModel_Site	None.

Sample Response

{
  "StartDate": "2023-02-08T06:23:43.0192734Z",
  "EndDate": "2023-02-09T06:23:43.0192734Z",
  "Sites": [
    {
      "SiteId": "08c27de3-835b-42fb-9ba2-8075082dda54",
      "SiteName": "Site 1",
      "DNSRequests": 13998,
      "BlockedDNSRequests": 133,
      "RiskyDNSRequests": 139
    },
    {
      "SiteId": "47a52ae6-8a87-45a3-a5d2-6f4c153a0b1d",
      "SiteName": "Site 2",
      "DNSRequests": 14892,
      "BlockedDNSRequests": 194,
      "RiskyDNSRequests": 161
    }
  ]
}

<GetDNSPTrafficSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <EndDate>2023-02-09T06:23:43.0192734Z</EndDate>
  <Sites>
    <GetDNSPTrafficSummaryResponseModel_Site>
      <BlockedDNSRequests>133</BlockedDNSRequests>
      <DNSRequests>13998</DNSRequests>
      <RiskyDNSRequests>139</RiskyDNSRequests>
      <SiteId>08c27de3-835b-42fb-9ba2-8075082dda54</SiteId>
      <SiteName>Site 1</SiteName>
    </GetDNSPTrafficSummaryResponseModel_Site>
    <GetDNSPTrafficSummaryResponseModel_Site>
      <BlockedDNSRequests>194</BlockedDNSRequests>
      <DNSRequests>14892</DNSRequests>
      <RiskyDNSRequests>161</RiskyDNSRequests>
      <SiteId>47a52ae6-8a87-45a3-a5d2-6f4c153a0b1d</SiteId>
      <SiteName>Site 2</SiteName>
    </GetDNSPTrafficSummaryResponseModel_Site>
  </Sites>
  <StartDate>2023-02-08T06:23:43.0192734Z</StartDate>
</GetDNSPTrafficSummaryResponseModel>

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