Batch export helps you incorporate platform-generated enterprise data into your data collection and analysis.

You can snapshot and batch export the following types of data for each client on demand and at scheduled intervals to Amazon AWS S3 and Microsoft Azure Blob Storage :

  • Ticket data
  • Alert data
  • Metric data
  • Inventory data
  • Usage data

Data is exported in JSON format. A list of failed exports is also provided if applicable.

The exported data content depends on the type and frequency of the export schedule, which determines the data items and quantity.

Only a partner can set up a batch export, and a partner can specify different data types by client for export. When a partner uses the API to create an export, the export is created for all clients who have not previously created the same export using the user interface. You can schedule batch exports using the Batch Export API.

The following batch export types for different data types are available:

Export TypeApplicable Data Type(s)Description
SnapshotInventoryThis data export provides a snapshot view of the data at the instance of export generation into the Amazon S3 bucket folder or Azure Blob storage.
IncrementalAlert, Ticket, MetricThe incremental batch export sends the previous three months of data as the first batch export. Subsequent exports are the incremental export of updated records. You can schedule recurring or on-demand data export:
  • On-demand - Export provides a snapshot of the data at the time of the generation of the export.
  • Recurring - Export provides snapshots of the data at the chosen time.
When you request incremental data on demand, the export generates a snapshot of the previous three months.

Metric data export occurs every hour by default and cannot be customized. You can get metric data using the metric APIs.

After exporting the data to the installed integrations you can view the exported data on the platform, AWS S3, and Azure Blob:

Batch Export Namebatch export name
Client Nameselected client name
Last Runtime and date of the last export
Last Exportstatus of the last export:
  • Success
  • Failed
Created Byauthor
ActionTo export data. The Run Now action is available only for data export with the On Demand Only option.

Step 1: Select the batch export add-on

  1. At the partner level or for a selected client, go to Setup > Integrations.
  2. Click Edit.
  3. Select the Add ons tab.
  4. Select Batch Exports.

Step 2: Install an export integration

Integrate with AWS S3 or Azure Blob to export the data to an AWS S3 bucket or an Azure Blob container.

Create Amazon AWS S3 bucket storage or Microsoft Azure Blob storage folders.

Step 3: Create a batch export

Select the data type, specify the export schedule, and select the integration target.

  1. Select Setup > Exports > Batch Export.

  2. From the BATCH EXPORT screen, click the + icon.

  3. Enter the following information:

    NameUnique name of the export.
    ClientClient for whom the data is exported.
    TypeType of data to export.

    When selecting Usage, the option to choose Failure Export Notification is presented. The email notification provides details about the Name, Type, Client, Schedule, Export Destination, Last Run Time and Date, and Created By information:
    Batch Export for Usage
    • On Demand Only generates exports when a request is created or rerun.
    • On-Demand and on Recurring Schedule generates export data when you raise a rerun request and generates an incremental export at scheduled intervals.
    Export toSpecify integration to AWS S3 or Azure Blob.
  4. Click Save & Run to apply the export and display export details:

Batch Export

View batch exports

You can view the configured Batch Export details in Exports > Batch Export. The BATCH EXPORT LIST page displays the details of the Batch Export.

View batch exports on AWS S3

You can view the generated batch exports in an AWS S3 bucket in the corresponding folders. For example, the alerts export is stored in the alerts folder:

View Batch Export in AWS S3

AWS stores the export files in S3 folders in JSON format. The export file name has the following encoding:

Export Name Details
  • (a) schedule of batch export, recurring or on-demand
  • (b) batch export type
  • (c) unique client ID
  • (d) schedule starting timestamp
  • (e) schedule ending timestamp
  • (f) recurring export serial number

View batch export on Azure Blob

You can view the generated data exports in the Azure Blob container in the corresponding folders:

View Batch Export in Azure Blob

Azure Blob stores the export files in Azure Blob containers in JSON format. The export file name has the encoding shown in the following figure:

Export Name Details
  • (A) schedule of batch export, recurring or on-demand
  • (B) batch export type
  • (C) unique client ID
  • (D) schedule starting timestamp
  • (E) schedule ending timestamp
  • (F) recurring export serial number