Get the hits or requests for all domains in a service type. Service-type should be one of the services you subscribe to: web, wsa, download, or vodstream. Refer to the mapping of these service types to QUANTIL's products. The region can be 'cn', 'nc', 'euna', or 'apac' representing Mainland China, near China, Europe/North America, and Asia Pacific, respectively. You may specify more than one area by separating them with semicolons. In addition, request parameters allow you to specify a time period, an interval type, and timezone for the output. An optional parameter lets you get hits for HTTPS traffic only or HTTP traffic only.
Header |
Description |
Required |
Authorization |
Authorization string for the request |
Yes |
Host |
URI for the QUANTIL SDK (i.e., api.quantil.com) |
Yes |
Date |
The date and time of the request. |
Yes |
Accept |
Indicates the accepted format (i.e., application/xml) |
Yes |
Parameter |
Description |
Required |
datefrom |
RFC3339 formatted date indicating the starting date. Example: 2013-01-01T22:30:00+08:00 |
Yes |
dateto |
RFC3339 formatted date indicating the ending date. Example: 2013-01-01T22:30:00+08:00 |
Yes |
type |
Indicates the granularity of time. Can be fiveminutes, hourly, or daily. |
Yes |
timezone |
Indicates the timezone for the report data. It must be relative to GMT and specified in the format GMT+n where -12<= n <= 12. For example, timezone=GMT-7 and timezone=GMT+8. If the parameter is unspecified, results will be in the GMT timezone. |
No |
https |
If true, return hits for domains using SSL. If false, return hits for domains not using SSL. If not specified, return all hits (SSL and non-HTTPS). |
No |
This request does not include an XML document in the request body.
GET /api/report/{service-type}/hit HTTP/1.1
Authorization: <authorization string>
Host: api.quantil.com
Date: <date>
Accept: application/xml
Here is the structure of a request using the curl utility.
curl -i --url https://api.quantil.com/api/report/ {service-type} /hit/{region} ?datefrom = {date from} & dateto = {date to}& type = {fiveminutes or Hourly or daily} & timezone = {timezone}& https = {https setting}
-X GET
-u {user}: {password}
-H 'Date: Fri, 26 Oct 2012 06:33:26 GMT'
-H 'Accept: application/xml'
curl -i --url 'https://api.quantil.com/api/report/download/hit/cn?datefrom=2014-08-15T00:00:00%2D00:00&dateto=2014-08-19T16:26:00%2D00:00&type=daily' -u test:aDz9B28yZtq7jyVQZjBls0OBZk4= -H 'Date: Thu, 07 Aug 2014 14:31:12 PDT' -H 'Accept: application/xml'
HTTP/1.1 200 OK
Date: <date>
Content-Type: application/xml; charset = utf-8
x-cnc-request-id: {id string auto generated by the QUANTIL server}
Element |
Description |
hit-report |
container for request (hit) information. It will contain one <hit-summary> child element and zero or more <hit-data> child elements indicating the number of requests at different times. |
hit-summary |
indicates total number of requests |
hit-data |
this container object contains a <timestamp> element and a <hit> element the number of requests for content |
timestamp |
indicates the date and time |
hit |
indicates number of hits or requests for objects |
The following example shows data on a daily interval.
HTTP/1.1 200 OK
Date: Thu, 21 Aug 2014 22:41:14 GMT
Accept-Ranges: bytes
Server: Restlet-Framework/2.1.0
x-cnc-request-id: 34854
ContentType: application/xml;charset=UTF-8
Content-Type: application/xml;charset=UTF-8
Content-Length: 562
<hit-report>
<hit-summary>3147</hit-summary>
<hit-data>
<timestamp>2014-08-15</timestamp>
<hit>418</hit>
</hit-data>
<hit-data>
<timestamp>2014-08-16</timestamp>
<hit>566</hit>
</hit-data>
<hit-data>
<timestamp>2014-08-17</timestamp>
<hit>2</hit>
</hit-data>
<hit-data>
<timestamp>2014-08-18</timestamp>
<hit>1106</hit>
</hit-data>
<hit-data>
<timestamp>2014-08-19</timestamp>
<hit>1050</hit>
</hit-data>
<hit-data>
<timestamp>2014-08-20</timestamp>
<hit>5</hit>
</hit-data>
</hit-report>
Error |
Description |
HTTP status code |
InvalidDatePeriod |
The date specified is invalid. |
400 |
InvalidReportType |
The report type specified is invalid. |
400 |
InvalidServiceArea |
The specified region is invalid |
400 |
InvalidServiceType |
The service type specified is invalid. |
400 |