Bomgar™ API Programmer's Guide

Reporting API

PDF Version (549KB)   Email This Item

Reporting API

The Bomgar 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 and exit survey reports of the /login administrative interface.

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

NOTE: By default, access to the API is SSL-encrypted; however, you can choose to allow HTTP access by checking the Allow HTTP Access to XML API Interface option from the Security page under the Management tab of the /login administrative interface. It is highly recommended that HTTP remain disallowed as a security best practice.

The reports page URL is http://support.example.com/api/reporting.ns.

An XML schema which formally describes the format of the returned reporting data is available at http://support.example.com/api/reporting.xsd.

The following HTTP request parameters are required for all reports:

<< Previous | Next >>

The Adobe® logo is a registered trademark of Adobe Systems Incorporated in the United States and/or other countries.