URL Parameters for the Analytical Reporting API

API requests for both synchronous and asynchronous usages can pass the following query parameters in the request URL:

Parameter	Description
displayStateString	Optional. By default, document status is returned as a numerical code. You can set this query parameter to `true` to receive a readable string status instead.
emitNull	Optional. By default, API responses include NULL field values. You can set this query parameter to `false` to exclude NULL field values.
filters	Optional. The list of filters that determines what results to include in the response. Filters passed in the URL must be presented as a comma-separated list of key:value pairs. For example `{"updatedDateFrom":"2017-06-19T00:00:00Z","updatedDateTo":"2017-07-19T00:00:00Z"}` Filters passed in the URL override filters passed in the JSON body of the request or in the view template. Note When specified in the URL, special characters in the filter list must be URL-encoded. The backslash character (`\`) must be double encoded, as follows: First, you must mark the character as literal by adding a second backslash character (`\\`). Then you must convert both characters to the URL code for a backslash, `%53C`. For example, URL encoding for `Directory2\Document2` would be `Directory2%53C%53CDocument2`.
includeInactive	Optional. By default, API responses do not include inactive records. You can set this query parameter to `true` to include inactive records in the responses.
product	Required for the GET /viewTemplates endpoint. Set value to `analytics`. Ensures that response returns view templates for use with the Analytical reporting API.
realm	Required. The realm name.