Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.voyado.com/llms.txt

Use this file to discover all available pages before exploring further.

BI Export delivers your Engage data as structured CSV files on your FTP server. The data is cleaned, curated, and organized into ready-to-use exports. You don’t need to build ingestion logic or transform the data yourself before analyzing it.

​
What is an export?

An export is a flat-file dataset for a single entity in Engage. Each export contains one logical table, delivered as a CSV file. For example:
  • The “Contact” export is a list of all contacts in your Engage instance
  • The “Receipt” export is a list of all transaction headers
  • The “Message” export is a list of all messages and their settings
Each export runs independently and produces its own file. Exports are performed once per day, during the night. The exact time is configurable in the Engage back-end.
Contact your implementation manager or CSM if you want to make changes to the export schedule.
While Delta Share delivers data as “data products” (packaged datasets that group multiple related tables around one business domain) BI Export delivers one table per file, per entity.

​
How exports relate

Although each export is delivered as an independent file, the exports are designed to be joined together. Every export contains shared identifier fields (GUIDs) that let you reconstruct relationships across the dataset.
  • Most exports revolve around “Contact” as the central entity
  • From there, “Receipt” and “ReceiptItem” connect via the receiptId value
  • Messages and their delivery events connect via messageId and deliveryId
  • And stores are joined via storeId
This matters when you plan your analytics. You will typically load multiple exports into your warehouse or BI tool and join them to generate insights. Here are some analysis examples:
  • Combine the “Receipt” and “ReceiptItem” exports using the receiptId value
  • Add also “Contact” using contactId to gain customer-level insight
Using the messageId and deliveryId values, join these four exports:
  • “Message”
  • “MessageDelivery”
  • “MessageOpen”
  • “MessageClick”
  • Join the “Receipt” and “Store” exports using storeId
Using the contactId value, join these exports:
  • `Contact
  • “PointAccount”
  • “PointTransaction”

​
BI exports available

Exports marked * are only available for customers using Design Studio.

​
Contact and loyalty

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Contact

Contact records per contact type. Exported columns are configurable
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Consent

Consent records and associated fields.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

PointAccount

Point balances per contact.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

PointTransaction

All point transactions.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

PredictiveScoring

Predictive scoring fields from the contact card.

​
Transactions

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Receipt

Transaction headers. One row per transaction. Joined to “ReceiptItem” export via receiptId.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

ReceiptItem

Transaction line items. Each row links back to its “Receipt” export header.

​
Messages & campaigns

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Message

All created messages and their settings. The root of the message-related exports.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

MessageDelivery

Which contacts received a message. Excludes control groups.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

MessageDeliveryStatus

Delivery status per sendout (Delivered, Blocked, and so on).
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

MessageOpen

Email-open events including user agent data.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

MessageClick

Click events with timestamps and target URLs.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

MessageControlGroup

Contacts that were assigned to the control group for a message.

​
Promotions

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Promotion

Promotion template information.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

PromotionRecipient

Recipients and their promotion status.

​
Segmentation

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Labels

All labels stored in Engage.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

LabelsToTaggedContact

Contacts with labels and which labels are applied.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

SavedSearch

All saved searches.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

TargetAudienceToContact

Which contacts belong to which target audience.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

MasterControlGroupHistory

Contacts included in the master control group.

​
Stores

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Store

All store records. Joined to “Receipt” export via storeId.

​
Design Studio

With the introduction of the Design Studio, new BI exports were introduced to Engage, enabling BI teams to analyze campaign structure, market distribution, and cross-market performance. In these exports, the central concepts are sendouts and marketing groups.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1

Learn about the sendout builder

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1

Learn about marketing groups

The Email, Sendout and MarketingGroup exports are only available for customers using Design Studio.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Email

Email-level data for sendouts created in Design Studio.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

Sendout

Records of sendouts created and managed in Design Studio.
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/developer-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=fbd08f956358ab12f664a7158e1a1399

MarketingGroup

The marketing Groups used to segment contacts by market.

​
Accessing your exports

To set up BI Export for your Engage instance, follow the setup guide on Help Center:
https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1

See how to export data to BI exports

Your exports, once processing is complete, are placed on Engage’s internal FTP server. 
[base-ftp-url]/integration/export
The Engage FTP server should only be used for transfer of BI export files and NOT for storage. Files older than 180 days will be automatically removed by housekeeping jobs.

​
Additional information

  • Exports run once per day. If you need higher-frequency access, consider using Delta Share.
  • The columns in the “Contact” export are configurable. To add or remove files, or to adjust exported fields, contact Support.
  • Exports marked * above require Design Studio.

​
Learn more

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1

See about control groups in message exports

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1

Understand message delivery statuses

https://mintcdn.com/voyado/Ns4bBcK3LNctK_Un/icons/help-center-link.png?fit=max&auto=format&n=Ns4bBcK3LNctK_Un&q=85&s=3e7ca2ce0b8cfb9fbd27a4bdf53b2ce1

Read about target audiences and saved searches