Skip to content
Voxbi Cockpit APIs
API Guides

Exports

An export is a background job that produces a downloadable file (CSV, XLSX, or XLS) from a slice of your system data. You request it from an entity's page, the platform queues a job, and a few minutes later the file is ready to download.

Overview

An export is started from the entity's own page (Users -> Export, Contacts -> Export) where you apply filters and choose columns and format. The Exports page is where you check status, download finished files, and delete old exports. A banner shows the retention window: completed files are kept on disk for a fixed number of days, then purged automatically. The row remains as a record, but the file is gone.

What it does

A worker runs the query and writes the file in the background, so you do not need to keep the page open while it runs.

Column What it shows
Owner The user who requested the export.
Model What was exported (Users, Contacts, or other entities that support export).
Status Pending, Processing, Completed, or Failed.
Duration How long the export took, in seconds.
Created at When the export was requested.
Started at When the background job picked it up.
Completed at When the file was written and made downloadable.

See also

  • Imports - the inbound companion.
  • Users, Contacts - the most commonly exported entities.
  • Events - the operational log where export job lifecycle is also recorded.

Form fields

Fields available in the create and edit forms.

General

User

The user who requested the export.

Resource type

The type of data that was exported, for example users or contacts.

Status

The current state of the export.

  • pending Pending Job queued, waiting for a worker.
  • processing Processing Worker is running the query and writing the file.
  • completed Completed File is ready. The Download button appears on the row.
  • failed Failed Job aborted. Check the Events feed for the reason.
Duration

How long the export took to finish, in seconds. Only shown after the export completes.

Created at

When the export was requested.

Started at

When background processing began.

Completed at

When the export finished processing.

Updated