GetSampleDefinitionResponse

result objectrequired

sampleCriteria object

The search logic used to build a sample

simpleFilter objectrequired

anyOf

• object
• object
• object
• object
• object
• object
• object
• object
• object
• object
• object
• object

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

samplePercentageinteger<int32>

The maximum percentage of the list you want to sample

Possible values: >= 0 and <= 100

sampleDefinitionIdSampleDefinitionId (string)

The ID for the desired sample definition

Example: SAMD_012345678901234

meta objectrequired

httpStatushttp status (string)required

http status

requestIdAn identifier of the incoming request. (string)required

An identifier of the incoming request.

noticeAn informational string about the request. (string)

An informational string about the request.

GetSampleDefinitionResponse

{
  "result": {
    "sampleCriteria": {
      "simpleFilter": {
        "filterType": "email",
        "comparison": "startsWith",
        "value": "string"
      }
    },
    "maxSampleSize": 0,
    "samplePercentage": 0,
    "sampleDefinitionId": "SAMD_012345678901234"
  },
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  }
}