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

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

XML data is pulled by sending a simple HTTP request to the BeyondTrust Appliance B Series. 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.

Even if your B Series 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.

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 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.

 

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.

Required Parameters for Reporting API
generate_report=[string]

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

SupportSession PresentationSessionRecording
SupportSessionListing SupportCustExitSurvey
SupportSessionSummary SupportRepExitSurvey
SupportSessionRecording SupportTeam
ShowMyScreenRecording ArchiveListing
CommandShellRecording Archive
PresentationSession LicenseUsage
PresentationSessionListing EndpointLicenseUsage

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.beyondtrust.com/namespaces/API/reporting

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