Optional

Various optional parameters can control the output of the query. These do not affect the data being queried, but rather adjust how it is presented.

Optional parameters

Unless otherwise noted, these parameters are available on most queries.

Parameter	Description
tz_offset	Controls the time-zone offset to return data in. Expressed as a full time zone offset string, ex: "+04:00". Defaults to +02:00.
format	Output as json (default) or csv. See response structure for examples.
sort_by	Specify a metric to sort results by. Default to users, can specify most other metrics.
sort	Output results in descending desc (default) or ascending asc order.
limit	Limit the number of results returned. Various defaults may apply based on type of query.
skip	Skip over the first number of results. Default to 0 and works with limit to enable pagination.
result_type	Which metrics to include in response. Default to basic (only user & session data) but can specify full or one or more of the metrics values.
resolution	Available only to timeseries queries. Controls the granularity of the result data. Can be one hour 1h (default), one day 1d, one week 1w or one month 1mon.
previous_period	Available on totals/metrics queries only. Include a comparison of the previous period by setting to 1.
include_session	Set to all to query unqualified data.