Skip to main content

UpdateSampleDefinitionRequest

sampleCriteria object

The search logic used to build a sample

simpleFilter objectrequired
anyOf
filterTypestringrequired

Possible values: [email, firstName, lastName, extRef, anyField]

comparisonStringComparison (string)required

Possible values: [startsWith, contains, doesNotContain, eq, neq]

valuestringrequired
maxSampleSizeinteger<int32>

The maximum size of any sample generated from this definition.

Possible values: >= 0

Default value: 0
UpdateSampleDefinitionRequest
{
"sampleCriteria": {
"simpleFilter": {
"filterType": "email",
"comparison": "startsWith",
"value": "string"
}
},
"maxSampleSize": 0
}