Skip to main content

Jobs

A job includes all the information regarding the ongoing export process. In the case of recurring export requests, the metrics included in the associated items are exported multiple times at regular intervals, leading to multiple export jobs for the same item.

Each job keeps track of:

  • the export status
  • the delivery status of any notification associated to the export
  • the timestamp indicating when the export started
Expired Exports

Connhex Exporter automatically identifies and deletes expired exports to prevent excessive disk usage. An export is considered expired if it satifies a configurable policy (for example, its creation date is older than a configurable threshold). Should a user attempt to download an expired export, he will receive an error message.

Structure​

Typescript

The following sections use Typescript to describe the structure of the data. This is done to facilitate the understanding of the data structure, but there's obviously no requirement to use Typescript in any of your code. For the complete API reference, please refer to the API documentation.

export enum ExportStatus {
  NotProcessed = 'notProcessed',
  InProgress = 'inProgress',
  Failed = 'failed',
  Done = 'done',
  Expired = 'expired',
}