Register an estimate interactions API task

Version:

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

To register a task:

Use the following API:
<instance>/sitecore/api/datatools/estimate/interactions
The successful task registration request returns the total count of interactions, for example:
{ "TotalCount": 34500 }

Parameters

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

Important

Combined parameters act as an AND condition. This means all the parameters sent to the API filter the data to purge.

Parameter	Optional	Default	Type	Description
`StartedDaysCutoff`	No	-	Nullable Integer	The `StartedDaysCutoff` parameter specifies the number of days since the interaction started. This parameter filters interactions based on its `StartDateTime` value. The `StartDateTime` reflects the interaction's starting `DateTime`. The `StartDateTime` value must not violate the configuration setting value for the minimum number of days for the data purge worker. The minimum available value is 180 days by default (see Configure the Cortex Processing Engine for task registration).
`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 interactions based on the percentile range and the `StartedDaysCutoff` 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 interactions based on the percentile range and the `StartedDaysCutoff` parameter.

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