OWStats (0.4.3)

Download OpenAPI specification:Download

This document lists API calls which can be made with owstats API.

Dates format in query parameters is YYYY-MM-DD

Responses are splitted by time intervals, corresponding to "property1" and "property2" in response samples of this documentation.
For performance reasons, depending on the data available in databases and the date range of the request, these time intervals can have different granularities in the response :

day : 2020-12-31
week : 2020-12-W06
month : 2020-12
year : 2020

Response sample in documentation :

    {
        "records": {
            "property1": { "visits": [...]},
            "property2": { "visits": [...]}
        }
    }

Possible corresponding response in "real" world :

    {
        "records": {
            "2018": {"visits": [...]},
            "2019-01": {"visits": [...]},
            "2019-W10": {"visits": [...]},
            "2019-03-11": {"visits": [...]}
        }
    }

Browser Visits

For a given domain and time span, it returns the number of sessions aggregated per browser and operating system.
A session corresponds to a visitor browsing one or more website's pages during a time window.
A session ends after 30 minutes of inactivity.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"visits": [{"browser": "string",
"browser_version": "string",
"platform": "string",
"platform_version": "string",
"value": "string"
}
]
},
"property2": {"visits": [{"browser": "string",
"browser_version": "string",
"platform": "string",
"platform_version": "string",
"value": "string"
}
]
}
}
}

Click truh Pages

For a given domain and time span, it returns the number of occurences of a user navigation between 2 pages of a website.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$
page	integer (Page to be retrieved) Default: 1

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"pages": [{"page_from": "string",
"page_to": "string",
"value": "string"
}
]
},
"property2": {"pages": [{"page_from": "string",
"page_to": "string",
"value": "string"
}
]
}
}
}

Domains

It returns the list of subdomains for a given domain name

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": ["string"
]
}

Domains Hits

For a given domain and time span, it returns the number of hits aggregated per subdomain.
A hit is a request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"hits": [{"subdomain": "string",
"value": "string"
}
]
},
"property2": {"hits": [{"subdomain": "string",
"value": "string"
}
]
}
}
}

Domains Error Hits

For a given domain and time span, it returns the number of error hits aggregated per subdomain.
An error hit is a request to get a file (.html, .css, .js, .jpg ..) which failed.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"errorhits": [{"subdomain": "string",
"value": "string"
}
]
},
"property2": {"errorhits": [{"subdomain": "string",
"value": "string"
}
]
}
}
}

Domains valid hits

For a given domain and time span, it returns the number of valid hits aggregated per subdomain.
A valid hit is a successful request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"validhits": [{"subdomain": "string",
"value": "string"
}
]
},
"property2": {"validhits": [{"subdomain": "string",
"value": "string"
}
]
}
}
}

Domains pages

For a given domain and time span, it returns the number of pages (success and errors) visited aggregated per subdomain.
Response is splitted by time interval.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"pages": [{"subdomain": "string",
"value": "string"
}
]
},
"property2": {"pages": [{"subdomain": "string",
"value": "string"
}
]
}
}
}

Domains error pages

For a given domain and time span, it returns the number of pages visited (errors) aggregated per subdomain.
Response is splitted by time interval.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"errorpages": [{"subdomain": "string",
"value": "string"
}
]
},
"property2": {"errorpages": [{"subdomain": "string",
"value": "string"
}
]
}
}
}

Domains Valid Pages

For a given domain and time span, it returns the number of pages visited (success) aggregated per subdomain.
Response is splitted by time interval.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"validpages": [{"subdomain": "string",
"value": "string"
}
]
},
"property2": {"validpages": [{"subdomain": "string",
"value": "string"
}
]
}
}
}

Geolocalization pages

For a given domain and time span, it returns the number of pages visited (error and success) aggregated per geolocalization of the visitor.
Geolocalization of a user is its country and region.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"pages": [{"country": "string",
"region": "string",
"value": "string"
}
]
},
"property2": {"pages": [{"country": "string",
"region": "string",
"value": "string"
}
]
}
}
}

Geolocalization visits

For a given domain and time span, it returns the number of user sessions aggregated per geolocalization of the visitor.
Geolocalization of a user is its country and region.
A session corresponds to a visitor browsing one or more website's pages during a time window.
A session ends after 30 minutes of inactivity.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"visits": [{"country": "string",
"region": "string",
"value": "string"
}
]
},
"property2": {"visits": [{"country": "string",
"region": "string",
"value": "string"
}
]
}
}
}

Geolocalization Hits

For a given domain and time span, it returns the number of hits aggregated per geolocalization of the visitor.
Geolocalization of a user is its country and region.
A hit is a request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"hits": [{"country": "string",
"region": "string",
"value": "string"
}
]
},
"property2": {"hits": [{"country": "string",
"region": "string",
"value": "string"
}
]
}
}
}

Hour Hits

For a given domain and time span, it returns the number of hits aggregated per hour (if response is splitted by time interval "day") or per day.
A hit is a request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"hits": [{"time": "string",
"value": "string"
}
]
},
"property2": {"hits": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour Valid Hits

For a given domain and time span, it returns the number of valid hits aggregated per hour (if response is splitted by time interval "day") or per day.
A valid hit is a successful request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"validhits": [{"time": "string",
"value": "string"
}
]
},
"property2": {"validhits": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour Error Hits

For a given domain and time span, it returns the number of error hits aggregated per hour (if response is splitted by time interval "day") or per day.
An error hit is a failed request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"errorhits": [{"time": "string",
"value": "string"
}
]
},
"property2": {"errorhits": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour bytes

For a given domain and time span, it returns the number of bytes transferred aggregated per hour (if response is splitted by time interval "day") or per day.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"bytes": [{"time": "string",
"value": "string"
}
]
},
"property2": {"bytes": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour Bounce pages

For a given domain and time span, it returns the number of times a user visited only one page of the website and left

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"bouncepages": [{"time": "string",
"value": "string"
}
]
},
"property2": {"bouncepages": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour entrance pages

For a given domain and time span, it returns the number of times a user entered a website

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"entrancepages": [{"time": "string",
"value": "string"
}
]
},
"property2": {"entrancepages": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour exit pages

For a given domain and time span, it returns the number of times a user exited a website

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"exitpages": [{"time": "string",
"value": "string"
}
]
},
"property2": {"exitpages": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour pages

For a given domain and time span, it returns the number of pages requests (error and success) aggregated per hour (if response is splitted by time interval "day") or per day.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"pages": [{"time": "string",
"value": "string"
}
]
},
"property2": {"pages": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour Valid Pages

For a given domain and time span, it returns the number of successful pages requests aggregated per hour (if response is splitted by time interval "day") or per day.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"validpages": [{"time": "string",
"value": "string"
}
]
},
"property2": {"validpages": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour Error pages

For a given domain and time span, it returns the number of pages requests in error aggregated per hour (if response is splitted by time interval "day") or per day.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"errorpages": [{"time": "string",
"value": "string"
}
]
},
"property2": {"errorpages": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour Pagetime

For a given domain and time span, it returns the number of seconds spent by users on the website.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"pagetime": [{"time": "string",
"value": "string"
}
]
},
"property2": {"pagetime": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour visits

For a given domain and time span, it returns the number of user sessions aggregated per hour (if response is splitted by time interval "day") or per day.
A session corresponds to a visitor browsing one or more website's pages during a time window.
A session ends after 30 minutes of inactivity.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"visits": [{"time": "string",
"value": "string"
}
]
},
"property2": {"visits": [{"time": "string",
"value": "string"
}
]
}
}
}

Hour Average Session Time

For a given domain and time span, it returns the average session time computed per hour (if response is splitted by time interval "day") or per day.
A session corresponds to a visitor browsing one or more website's pages during a time window.
A session ends after 30 minutes of inactivity.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"avgsessiontime": [{"time": "string",
"value": "string"
}
]
},
"property2": {"avgsessiontime": [{"time": "string",
"value": "string"
}
]
}
}
}

Initial Path Visits

For a given domain and time span, it returns the number of user sessions aggregated per initial path.
Initial path is the first 3 pages of a website browsed by a visitor.
A session corresponds to a visitor browsing one or more website's pages during a time window.
A session ends after 30 minutes of inactivity.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$
page	integer (Page to be retrieved) Default: 1

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"visits": [{"page_1": "string",
"page_2": "string",
"page_3": "string",
"value": "string"
}
]
},
"property2": {"visits": [{"page_1": "string",
"page_2": "string",
"page_3": "string",
"value": "string"
}
]
}
}
}

Request Form Valid Hits

For a given domain and time span, it returns the number of valid hits aggregated per form.
A form is the html element form
A valid hit is a successful request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$
page	integer (Page to be retrieved) Default: 1

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"validhits": [{"post_form": "string",
"value": "string"
}
]
},
"property2": {"validhits": [{"post_form": "string",
"value": "string"
}
]
}
}
}

Robots Bytes

For a given domain and time span, it returns the bytes transferred aggregated per robot type.
Robots are used by many search engines to automatically browse the web and index your site.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"bytes": [{"robot_agent": "string",
"useragent": "string",
"value": "string"
}
]
},
"property2": {"bytes": [{"robot_agent": "string",
"useragent": "string",
"value": "string"
}
]
}
}
}

Robots Error Hits

For a given domain and time span, it returns the number of error hits aggregated per robot type.
Robots are used by many search engines to automatically browse the web and index your site.
An error hit is a failed request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"errorhits": [{"robot_agent": "string",
"useragent": "string",
"value": "string"
}
]
},
"property2": {"errorhits": [{"robot_agent": "string",
"useragent": "string",
"value": "string"
}
]
}
}
}

Robots Valid Hits

For a given domain and time span, it returns the number of valid hits aggregated per robot type.
Robots are used by many search engines to automatically browse the web and index your site.
A Valid hit is a successful request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"validhits": [{"robot_agent": "string",
"useragent": "string",
"value": "string"
}
]
},
"property2": {"validhits": [{"robot_agent": "string",
"useragent": "string",
"value": "string"
}
]
}
}
}

Robots pages hits

For a given domain and time span, it returns the number of hits aggregated per robot type and page.
Robots are used by many search engines to automatically browse the web and index your site.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$
page	integer (Page to be retrieved) Default: 1

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"hits": [{"robot_agent": "string",
"useragent": "string",
"request_origfilepath": "string",
"value": "string"
}
]
},
"property2": {"hits": [{"robot_agent": "string",
"useragent": "string",
"request_origfilepath": "string",
"value": "string"
}
]
}
}
}

Status Valid Hits

For a given domain and time span, it returns the number of valid hits aggregated per status code.
A Valid hit is a successful request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"validhits": [{"status_code": "string",
"value": "string"
}
]
},
"property2": {"validhits": [{"status_code": "string",
"value": "string"
}
]
}
}
}

Status Error Hits

For a given domain and time span, it returns the number of error hits aggregated per status code.
An error hit is a failed request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"errorhits": [{"status_code": "string",
"value": "string"
}
]
},
"property2": {"errorhits": [{"status_code": "string",
"value": "string"
}
]
}
}
}

Status Hits

For a given domain and time span, it returns the number of hits aggregated per status code.
A hit is a request to get a file (.html, .css, .js, .jpg ..).

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"hits": [{"status_code": "string",
"value": "string"
}
]
},
"property2": {"hits": [{"status_code": "string",
"value": "string"
}
]
}
}
}

Status Valid Pages

For a given domain and time span, it returns the number of valid pages requests aggregated per status code.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"validpages": [{"status_code": "string",
"value": "string"
}
]
},
"property2": {"validpages": [{"status_code": "string",
"value": "string"
}
]
}
}
}

Status Error Pages

For a given domain and time span, it returns the number of failed pages requests aggregated per status code.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"errorpages": [{"status_code": "string",
"value": "string"
}
]
},
"property2": {"errorpages": [{"status_code": "string",
"value": "string"
}
]
}
}
}

Status Pages

For a given domain and time span, it returns the number of pages requests aggregated per status code.

path Parameters

domain

required

string (Domain to query)

query Parameters

subdomain	string (Subdomain to query) Default: ""
start_date required	string (Start of the selection) ^\d{4}-\d{2}-\d{2}$
end_date required	string (End of the selection (inclusive)) ^\d{4}-\d{2}-\d{2}$

Responses

Response samples

200
422

Content type

application/json

{"records": {"property1": {"pages": [{"status_code": "string",
"value": "string"
}
]
},
"property2": {"pages": [{"status_code": "string",
"value": "string"
}
]
}
}
}