Download Reports with ArchiveListing

The ArchiveListing query returns a list of available state archives and event archives for a given date. History is stored for the past seven active days (days that the Bomgar Appliance's processes have been running).

State archives are created automatically every thirty minutes, and event archives contain events spanning an interval of ten minutes. Each listing represents an archive that is available for download.

Archives are not available immediately after the time they represent. It may take a few minutes for a state or event archive to be created. It is helpful to query ArchiveListing before querying Archive to be sure that the archive has been created.

The reporting API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Remote Support API. The API account must have the permission Allow Access to Archive Reports.

IMPORTANT!

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.

Parameters for ArchiveListing

date=[YYYY-MM-DD] Specifies the date for which to return a list of archives.

XML Response for ArchiveListing Query

<archives> Contains zero or more <state_archive> and/or <event_archive> elements. A state archive contains a snapshot of the system state at a given time. An event archive contains an ordered list of events that occurred between two points in time.

Element Names and Attributes

/archives/state_archive
<time>

The time at which the snapshot of the system's state was taken, returned in ISO 8601 format. Also contains a timestamp attribute which displays the time as a UNIX timestamp (UTC).

<index>

The state archive's unique index for the given day. The first state archive of the day always starts at 1. This corresponds with the index of the state archive report.

<event_archive_index>

The index of the event archive that starts immediately after the snapshot was taken.

/archives/event_archive
<time> The time of the first possible event in the archive, returned in ISO 8601 format. Also contains a timestamp attribute which displays the start time as a UNIX timestamp (UTC).
<end_time> The time of the last possible event in the archive, returned in ISO 8601 format. Also contains a timestamp attribute which displays the end time as a UNIX timestamp (UTC).
<index>

The archive's unique index for the given day. The first event archive of the day always starts at 1. This corresponds with the index of the event archive report.

Query Example for ArchiveListing

Archive listings for the date of October 1 2016
  • https://support.example.com/api/reporting?generate_report=ArchiveListing&date=2016-10-01