Get Route Summary Query

Retrieves the total number of DNS queries over a given time period for either of the following:

• All primary and secondary zones
• A specific primary or secondary zone

Request

A request to retrieve DNS query summary information is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/reporting/customers/AccountNumber/routesummary?zoneid=ZoneID&zonename=ZoneName&begindate=StartDateTime&enddate=EndDateTime

Omit the zoneid and zonename query string parameters to retrieve statistics for all primary and secondary zones.

Define the following variables when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper right-hand corner of the MCC.
ZoneID	Replace this variable with either of the following values: 0: Retrieves DNS queries for all zones. ID: Replace this variable with the system-defined ID of the desired primary or secondary zone. Retrieve a list of all primary and secondary zones and their system-defined IDs through the Get All Zones endpoint.
ZoneName	Replace this variable with the name of the desired zone.
StartDateTime Required	Replace this variable with the start date/time for the report. Only activity that took place after the specified date/time will be included in the report. Format: YYYY-MM-DDThh:mm:ss Note: Time (i.e., Thh:mm:ss) is optional. If time is not specified, then a default time (i.e., 00:00:00) will be used. Learn more about date/time format.
EndDateTime Required	Replace this variable with the end date/time for the report. Activity that took place after the specified date/time will not be included in the report. Format: YYYY-MM-DDThh:mm:ss Note: Time (i.e., Thh:mm:ss) is optional. If time is not specified, then a default time (i.e., 00:00:00) will be used. Learn more about date/time format.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters for each zone returned by this endpoint:

Name	Data Type	Description
Zone	String	Identifies a primary or secondary zone by its name.
Id	Integer	Identifies a primary or secondary zone by its system-defined ID.
QueryCount	String	Indicates the number of DNS queries that were received for the zone identified by the Zone response parameter.

Errors

The response body for an unsuccessful request may contain an error parameter that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is provided below.

A sample JSON response is provided below.

[{
		"Zone" : "example.net.",
		"Id" : 4528,
		"QueryCount" : "1234"
	}, {
		"Zone" : "myexample.com.",
		"Id" : 4566,
		"QueryCount" : "1235"
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<ArrayOfDnsZoneRecordSummaryAPI xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<DnsZoneRecordSummaryAPI>
		<Zone>example.net.</Zone>
		<Id>4528</Id>
		<QueryCount>1234</QueryCount>
	</DnsZoneRecordSummaryAPI>
	<DnsZoneRecordSummaryAPI>
		<Zone>myexample.com.</Zone>
		<Id>4566</Id>
		<QueryCount>1235</QueryCount>
	</DnsZoneRecordSummaryAPI>
</ArrayOfDnsZoneRecordSummaryAPI>