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

NameDescriptionTypeAdditional 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.

Body Parameters

None.

Response Information

Resource Description

Traffic summary information for GSM sites.

GetDNSPTrafficSummaryResponseModel
NameDescriptionTypeAdditional 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": "2019-05-21T21:11:51.3046567Z",
  "EndDate": "2019-05-22T21:11:51.3046567Z",
  "Sites": [
    {
      "SiteId": "ba25cdfd-9a7e-445c-b810-d145e6722ee4",
      "SiteName": "Site 1",
      "DNSRequests": 12263,
      "BlockedDNSRequests": 193,
      "RiskyDNSRequests": 167
    },
    {
      "SiteId": "7e5c5f30-1fbf-4511-8d9a-a28f2e772fdf",
      "SiteName": "Site 2",
      "DNSRequests": 13265,
      "BlockedDNSRequests": 180,
      "RiskyDNSRequests": 182
    }
  ]
}                    
<GetDNSPTrafficSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <EndDate>2019-05-22T21:11:51.3046567Z</EndDate>
  <Sites>
    <GetDNSPTrafficSummaryResponseModel_Site>
      <BlockedDNSRequests>193</BlockedDNSRequests>
      <DNSRequests>12263</DNSRequests>
      <RiskyDNSRequests>167</RiskyDNSRequests>
      <SiteId>ba25cdfd-9a7e-445c-b810-d145e6722ee4</SiteId>
      <SiteName>Site 1</SiteName>
    </GetDNSPTrafficSummaryResponseModel_Site>
    <GetDNSPTrafficSummaryResponseModel_Site>
      <BlockedDNSRequests>180</BlockedDNSRequests>
      <DNSRequests>13265</DNSRequests>
      <RiskyDNSRequests>182</RiskyDNSRequests>
      <SiteId>7e5c5f30-1fbf-4511-8d9a-a28f2e772fdf</SiteId>
      <SiteName>Site 2</SiteName>
    </GetDNSPTrafficSummaryResponseModel_Site>
  </Sites>
  <StartDate>2019-05-21T21:11:51.3046567Z</StartDate>
</GetDNSPTrafficSummaryResponseModel>