Common Parameters


These parameters are common to many of the requests and are grouped here for reference. See the individual requests to find which parameters are present.

Parameters

Parameter Description
from Only return results from on or after the from-date. The from-date should be specified in escaped ISO format e.g. 2014-12-09+09:00:00. Mandatory in many requests.
to Only return results from before the to-date. The to-date should be specified in escaped ISO format e.g. 2014-12-09+17:00:00.
type Filter results by the selected hit type(s): page, AJAX or event. Recommended in some requests.
protocol Filter results by the selected protocol(s).
host Filter results by the selected host(s).
path Filter results by the selected path(s).
queryparams Filter results by the selected queryparam(s).
title Filter results by the selected title(s).
user Filter results by the selected user(s).
session Filter results by the selected session(s).
server Filter results by the selected server(s).
referrer Filter results by the selected referrer(s).
browser Deprecated. Filter results by the selected browser(s). E.g. “msie:11”
browserfamily Filter results by the selected browser family. E.g. “IE”
browserversion Filter results by the selected browser version. E.g. “11.0”
browsermode Filter results by the selected browser mode (for IE only) E.g. “11.0”
os Deprecated. Filter results by the selected operating system(s). E.g. “Windows 10”
osfamily Filter results by the selected Operating System Family. E.g. “Android” or “Mac OS X”
osversion Filter results by the selected Operating System Version. E.g. “4.4”
devicefamily Filter results by the selected Device Family. E.g. “iPad” or “Other” for non-mobile devices.
clientip Filter results by the selected client IP address(es).
client Filter results by the selected client(s).
country Filter results by the selected country(s).
continent Filter results by the selected continent(s).
domain Filter results by the selected domain(s).
sort Order results by field in ascending/descending order (e.g. sort=hits)
limit Cap the number of results shown (e.g. limit=1000)