Service Type Page View Report - GET /api/report/{service-type}/pv
Get the page views for all domains of a particular 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. Request parameters allow you to specify a time period, an interval type, and timezone for the output. An optional parameter lets you get status codes 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 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 page views for domains using SSL. If false, return page views for domains not using SSL. If not specified, return all page views (SSL and non-SSL). |
No |
This request does not include an XML document in the request body.
GET /api/report/{service-type}/pv/ 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} /pv ?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/pv?datefrom=2014-09-11T00:00:00%2D08:00&dateto=2014-09-20T23:59:59%2D08:00&type=daily&timezone=GMT%2B08' -u apiuser:XP9Df3yl42255HQty4IFy3JfVUVs= -H 'Date: Wed, 08 Oct 2014 18:07:46 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 |
pv-report |
container for page view information. It will contain zero or more <pv-data> child elements indicating page views at different times. |
pv-data |
this container object contains a <timestamp> element and a <pv> element describing the page views at a particular time. |
timestamp |
indicates the date and time |
pv |
number of page views |
The following shows daily page view data.
HTTP/1.1 200 OK
Date: Thu, 09 Oct 2014 01:07:44 GMT
Accept-Ranges: bytes
Server: WS-web-server
x-cnc-request-id: 3922739
ContentType: application/xml;charset=UTF-8
Content-Type: application/xml;charset=UTF-8
Content-Length: 912
<pv-report>
<pv-data>
<timestamp>2014-09-11</timestamp>
<pv>914</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-12</timestamp>
<pv>1063</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-13</timestamp>
<pv>1168</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-14</timestamp>
<pv>1212</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-15</timestamp>
<pv>1312</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-16</timestamp>
<pv>1276</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-17</timestamp>
<pv>1292</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-18</timestamp>
<pv>1119</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-19</timestamp>
<pv>989</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-20</timestamp>
<pv>947</pv>
</pv-data>
<pv-data>
<timestamp>2014-09-21</timestamp>
<pv>1257</pv>
</pv-data>
</pv-report>
Error |
Description |
HTTP status code |
InvalidDatePeriod |
The date specified is invalid. |
400 |
InvalidReportType |
The report type specified is invalid. |
400 |
InvalidServiceType |
The service type specified is invalid. |
400 |