Web API for xConnect Data Tools

Register an interaction data export task

Version:

You can use the xConnect Web API to export interaction data. To do this, you must register a data export task.

To register an interaction data export task:

Use the following API:
<instance>/sitecore/api/datatools/export/tasks/interactions
The successful task registration request returns the task ID used for status monitoring, for example:
{ "TaskId": "049cd8b3-b120-4949-a42f-cdc2fe4f3086" }

Parameters

The following describes the POST parameters that you can send to the Web API to register an interaction data export task:

Parameter	Optional	Default value	Type	Description
`BatchSize`	Yes	100	Integer	The data extraction batch size of contacts The `BatchSize` system parameter controls the amount of data extracted from the collection database for each cursor read.
`DefaultSplitItemCount`	Yes	100	Integer	Contact data extraction cursor split count. The `DefaultSplitItemCount` system parameter controls the split process of contact data extraction.
`ExpiresAfterHours`	Yes	24	Integer	The expiration of the task in the final state. The final task status is either successful or failed and removed from the system after the expiration period.
`StorageProfile`	No	-	String	The name of a profile with predefined storage provider settin (such as network folder location or storage account connection string). The storage profile must be registered in the Cortex Processing Engine, otherwise Sitecore does not register the task and the `ModelValidationException` error is thrown.
`StartedDaysCutoff`	Yes	Null	Nullable Integer	Minimum number of days since the contact started the interaction with the brand. The data extraction process uses this parameter to filter contacts based on the `StartDateTime` value. The `StartDateTime` date-time reflects the starting date of the interaction. Interactions that started less than `StartedDaysCutOff` days ago are not included in the data export.
`StartPercentile`	Yes	Null	Nullable double	The start sampling range value. The range restriction is 0 to 1. The percentile range specifies the subset of data to extract. Use this parameter to perform the purging in small batches to avoid stressing the system too much. The data extraction process filters contacts based on the percentile range and the `CutOffDays` parameter.
`EndPercentile`	Yes	Null	Nullable double	The end sampling range value. The range restriction is 0 to 1. The percentile range specifies the subset of data to extract. Use this parameter to perform the purging in small batches to avoid stressing the system too much. The data extraction process filters contacts based on the percentile range and the `CutOffDays` parameter.

If you have suggestions for improving this article, let us know!