Documentation Center

delete_analytic

Deletes a stored report object from the server.

Parameters

action
delete_analytic
fid
The type of the stored analytics object, either "analytics.snapshot" or "analytics.report"
name
The unique identifier for the stored analytics object

Example URL

http://<host>:<port>/<context>/web/analytics.xql?action=delete_analytic&fid=<value>&name=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.

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.