Export
Segments are at the core of the data export functionality. They enable users to build complex search queries using Search Criteria Rows (SCR) through a user-friendly interface. This allows for flexible and powerful filtering of data before export.
Segment Groups enhance this capability by allowing you to combine or filter multiple segments using logical operators such as AND, OR, and EXCEPT. This makes it easier to define precise data sets based on multiple conditions and reuse segments across other export operations.
The Bulk Export APIs support data retrieval for both Segments and Segment Groups. Both sets of APIs follow the same structure and usage pattern, ensuring a consistent developer experience regardless of which method you choose to work with. Using the Bulk Export API, you can establish near real-time integrations between MyPreferences and other systems, support audience-building use cases, or build an internal service that receives updates at specific intervals.
In addition to retrieving data from segments and segment groups in full, incremental access is also supported by including lastdatetime when initiating the request.
Workflow
- Define: Create a segment (or segment group) in MyPreferences that defines the dataset you want to retrieve.
- Invoke: Invoke the Initiate endpoint to request the generation of data. You can optionally supply a
callback URLto be notified when the data is ready for retrieval. - Status: Check the status of your export by polling the Status endpoint using the access token.
- Retrieve: Retrieve the data.
All data export requests are processed sequentially. If you initiate two exports, the second export will not begin processing until the first one has finished. A maximum of five (5) export requests can be initiated concurrently. There is a configurable daily limit on the number of exports that can be processed.
On this page
- Export