Register an estimate contacts API task

Abstract

How to register contact estimate tasks with the xConnect estimate tool Web API.

You can use the xConnect Web API to estimate the amount of data to purge from your contacts. To do this, you must register an estimate task.

To register a task:

  • Use the following API:

    <instance>/sitecore/api/datatools/estimate/contacts

    The successful task registration request returns the total count of contacts, for example:

    {
        "TotalCount": 2270
    }

Parameters

The following describes the POST parameters that you can send to the Web API to register a purge task:

Parameter

Optional

Default

Type

Description

CutoffDays

No

-

Nullable Integer

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

The CutoffDays parameter specifies the number of days the contact has not interacted with the brand. The data extraction process uses this parameter to filter contacts based on the contact’s 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.

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.

The data extraction process filters contacts based on the percentile range and the CutOffDays parameter.