Register a contact data export task

Version: 10.4

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

To register a contact data export task:

  • Use the following API:

    RequestResponse
    <instance>/sitecore/api/datatools/export/tasks/contacts

    The successful task registration request returns the task ID used for status monitoring, for example:

    RequestResponse
    {
        "TaskId": "049cd8b3-b120-4949-a42f-cdc2fe4f3086"
    }

Parameters

The following describes the POST parameters that you can send to the Web API to register a 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.

CutoffDays

Yes

Null

Nullable

Integer

The last contact activity must be greater or equal to the specified amount of days. The range restriction is 0 to the int.MaxValue.

The CutoffDays parameter specifies the number of days the contact is not interacting with the brand.

The data extraction process uses this parameter to filter contacts based on the LastModified value. The LastModified date-time reflects the last interaction of the contact.

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.

Do you have some feedback for us?

If you have suggestions for improving this article,