filter

Provides an XML or HTML representation of the analytics filtering options on this system.

Description

The filtering options on a given system are determined by examining both the content, groups, and languages available on the system, but also examining the audit trails that have been aggregated on to this system to look for additional unrepresented options. All of this information is compiled inot the filtering options, and then made available as HTML or XML through this API function.

Parameters

action
filter
format
The output format for the results. Either "html" or "xml". Defaults to "html"

Example URL

http://<host>:<port>/<context>/web/analytics.xql?action=filter&format=<value>

Successful Result

The filtering options for this system, either as an HTML UI usable only within the Analytics page, or as an XML instance.

Failed Result

Accessing this API feature requires the "Use analytics" permission, and the function will throw a permission exception if the permission is not available.