Reporting API

The reporting API is designed to enable you to pull reporting data in XML format, suitable for importing into external databases and applications. The data presented is the same as in the session reports of the /login administrative interface.

XML data is pulled by sending a simple HTTP request to the B Series Appliance. The request can be sent using any HTTPS-capable socket library, scripting language module, or a URL fetcher such as cURL or wget. Either GET or POST may be used as the request method.

POST requests must include a Content-Type: application/x-www-form-urlencoded HTTP header when supplying parameters in the request body, and the parameters must be url-encoded. Multipart POST requests are not supported.


When making consecutive API calls, you must close the connection after each API call.

The reporting API URL is

An XML schema which formally describes the format of the returned reporting data is available at

The reporting API is an authenticated API. For instructions on using authenticated APIs using OAuth, please see Authenticate to the Privileged Remote Access API.

Required Parameter for Reporting API


The type of report to be generated. Report types can be any of the following:

AccessSession AccessSessionSummary
AccessSessionListing CommandShellRecording
AccessSessionRecording UserRecording
Team EndpointLicenseUsage

The reporting API returns XML responses that declare a namespace. If you are parsing these responses with a namespace-aware parser, you must set the namespace appropriately or ignore the namespace while parsing the XML.

Reporting API:

The above namespace is returned XML data and is not a functional URL.