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 Appliance. 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 that even if your Bomgar Appliance has multiple public sites, all reports return data associated with all public sites unless the request contains a specific parameter to limit the sites pulled.
When making consecutive API calls, you must close the connection after each API call.
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 option on the Management > API Configuration page of the /login administrative interface. It is highly recommended that HTTP remain disallowed as a security best practice.
The reporting API URL is https://support.example.com/api/reporting.
An XML schema which formally describes the format of the returned reporting data is available at https://support.example.com/api/reporting.xsd.
In order to issue an API request to the reporting API, you will need to supply the username and password for a Bomgar user account. That account must have the reporting permission Allowed to use reporting API. The account must also have one or more of the following permissions, depending upon which type of reports you wish to run: Allowed to View Support Session Reports for only his or her sessions, his or her teams' sessions, or all sessions; Allowed to view support session recordings; Allowed to View Presentation Session Reports for only his or her sessions, his or her teams' sessions, or all sessions; and Allowed to View the License Usage Reports. To run ArchiveListing or Archive, the account must also be an administrator.
To run ArchiveListing or Archive reports, ensure that the Enable State Archive API option is checked on the Management > API Configuration page of the /login administrative interface. The state archive API can be enabled independently of other APIs.
|username=[string]||The username to use when retrieving the reports. This user must have permission to use the reporting API. The user must also have permission to view reports. Reports returned will depend on the user's specific reporting permissions. To run Archive Listing or Archive, the account must also be an administrator.|
|password=[string]||The password associated with this username.|
The type of report to be generated. Report types can be any of the following:
Starting with Bomgar 14.1, the reporting API returns XML responses that declare a namespace. If you are parsing these responses with a namespace-aware parser, you will need to set the namespace appropriately or ignore the namespace while parsing the XML.
- Reporting API: https://www.bomgar.com/namespaces/API/reporting
Note: The above namespace is returned XML data and is not a functional URL.
If you started using the API prior to 14.1, this change could break backward compatibility with current integrations if namespaces are not handled properly. If possible, test your code on a site running Bomgar 14.1.1 or up before upgrading.