Origin Status Code Detail Report - GET /api/report/origin-status-code/detail
Get details on HTTP status codes returned from the origin for all of your domains' objects. Details include each status code and the number of times each was returned. Request parameters allow you to specify a time period and interval type. 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 |
https |
If true, return status codes for domains using SSL. If false, return status codes for domains not using SSL. If not specified, return all status codes (SSL and non-SSL). |
No |
This request does not include an XML document in the request body.
GET /api/report/status-code/detail 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/origin-status-code/detail ?datefrom = {date from} & dateto = {date to}& 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/origin-status-code/detail?datefrom=2015-02-01T00:00:00%2B09:00&dateto=2015-02-01T02:00:00%2B09:00&type=hourly' -u test:HKE1Mc6DMDkuq0211V7rD5xIybQ= -H 'Date: Fri, 08 Aug 2014 12:49:03 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 |
status-code-report |
container for status code information. It will contain zero or more <status-code-data> elements each describing the number of times a status code was returned during a time period. |
status-code-data |
a container object which includes a <timestamp> element and a <details> element which describes all the status codes that appeared during a particular time. |
timestamp |
indicates a point in time. Example: 2015-04-01 13:00 would indicate the 1pm hour on April 1, 2015. |
details |
a container which includes one or more <detail> elements describing each status code that appeared. |
detail |
a container which includes one <status-code> element and one <requests> element indicating the number of times a status code was returned. |
status-code |
an HTTP status code. Example: 200 |
requests |
indicates the number of times the status code was returned. |
HTTP/1.1 200 OK
Date: Thu, 19 Feb 2015 01:48:42 GMT
Accept-Ranges: bytes
Server: WS-web-server
x-cnc-request-id: 6698846
ContentType: application/xml;charset=UTF-8
Content-Type: application/xml;charset=UTF-8
Content-Length: 2120
<status-code-report>
<status-code-data>
<timestamp>2015-01-31 15</timestamp>
<details>
<detail>
<status-code>0</status-code>
<requests>398</requests>
</detail>
<detail>
<status-code>5XX</status-code>
<requests>647</requests>
</detail>
<detail>
<status-code>302</status-code>
<requests>362</requests>
</detail>
<detail>
<status-code>200</status-code>
<requests>881</requests>
</detail>
<detail>
<status-code>4XX</status-code>
<requests>259</requests>
</detail>
<detail>
<status-code>400</status-code>
<requests>259</requests>
</detail>
<detail>
<status-code>502</status-code>
<requests>329</requests>
</detail>
<detail>
<status-code>all</status-code>
<requests>2547</requests>
</detail>
<detail>
<status-code>500</status-code>
<requests>318</requests>
</detail>
</details>
</status-code-data>
<status-code-data>
<timestamp>2015-01-31 16</timestamp>
<details>
<detail>
<status-code>0</status-code>
<requests>335</requests>
</detail>
<detail>
<status-code>5XX</status-code>
<requests>660</requests>
</detail>
<detail>
<status-code>302</status-code>
<requests>224</requests>
</detail>
<detail>
<status-code>200</status-code>
<requests>932</requests>
</detail>
<detail>
<status-code>4XX</status-code>
<requests>371</requests>
</detail>
<detail>
<status-code>400</status-code>
<requests>371</requests>
</detail>
<detail>
<status-code>502</status-code>
<requests>373</requests>
</detail>
<detail>
<status-code>all</status-code>
<requests>2522</requests>
</detail>
<detail>
<status-code>500</status-code>
<requests>287</requests>
</detail>
</details>
</status-code-data>
</status-code-report>
Error |
Description |
HTTP status code |
InvalidDatePeriod |
The date specified is invalid. |
400 |
InvalidReportType |
The report type specified is invalid. |
400 |