Schedule
Retrieve Export Schedule data. This call only outputs fields that are configured in your export schedule.
| API | Description |
|---|---|
| POST {clientId}/export/Schedule/{scheduleName}?startDate={startDate}&endDate={endDate} |
Initiate request by specifying an Export Schedule name. You can optionally pass-in both a start and an end date (both required, if either provided); otherwise, if dates are not provided, the export will not be restricted to a date range. |
| GET {clientId}/export/Schedule/{accessToken}?limit={limit}&offset={offset}&keepAlive={keepAlive} |
Retrieve the data. You may iterate through multiple calls until all records are retrieved. The access token will expire automatically upon complete data retrieval. Set the keepAlive parameter to true to retrieve data beyond the initial retrieval. The default value is set to false, if not specified. |
| POST {clientId}/export/Schedule/Commit/{accessToken}?keepFiles={keepFiles} |
This endpoint should only be accessed if the keepAlive parameter was set to true when retrieving the data. Invoking this endpoint marks the data retrieval as “complete” and expires the access token. |
Segment
Retrieve Segment data in Full or Incremental batches.
| API | Description |
|---|---|
| POST {clientId}/export/Segment/{segmentName} |
Initiate request by specifying a Segment name. You can optionally pass lastdatetime to retrieve preference updates for a specific period. |
| GET {clientId}/status/Token/{accessToken} |
Returns the status of your request. If a callback URL is provided with your request, MyPreferences will POST the status to the callback URL. |
| GET {clientId}/export/Segment/{accessToken}?limit={limit}&offset={offset}&keepAlive={keepAlive} |
Retrieve the data. You may iterate through multiple calls until all records are retrieved. The access token will expire automatically upon complete data retrieval. Set the keepAlive parameter to true to retrieve data beyond the initial retrieval. The default value is set to false, if not specified. |
| POST {clientId}/export/Segment/Commit/{accessToken}?keepFiles={keepFiles} |
This endpoint should only be accessed if the keepAlive parameter was set to true when retrieving the data. Invoking this endpoint marks the data retrieval as “complete” and expires the access token. |
CID
Retrieve Preferences for IDs across one or more preference offerings. This call does not output implied preferences.
NOTE: A single API request can include a maximum of 10,000 CIDs.
| API | Description |
|---|---|
| POST {clientId}/export/CID?startDate={startDate}&endDate={endDate} |
Initiate CID export request, provding one or more CID values and one or more channel names. |
| GET {clientId}/export/CID/{accessToken}?limit={limit}&offset={offset}&keepAlive={keepAlive} |
Retrieve the data. You may iterate through multiple calls until all records are retrieved. The access token will expire automatically upon complete data retrieval. Set the keepAlive parameter to true to retrieve data beyond the initial retrieval. The default value is set to false, if not specified. |
| POST {clientId}/export/CID/Commit/{accessToken}?keepFiles={keepFiles} |
This endpoint should only be accessed if the keepAlive parameter was set to true when retrieving the data. Invoking this endpoint marks the data retrieval as “complete” and expires the access token. |