Skip to content

Preview a saved-match segment materialization

POST
/v1/integration-match-collections/{collectionId}/materializations/preview
curl --request POST \
--url https://api.infiniteaudience.ai/v1/integration-match-collections/example/materializations/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "filters": { "providers": [ "example" ], "connection_ids": [ "example" ], "integration_run_ids": [ "example" ], "source_kinds": [ "recurring" ], "boundary_at_from": "2026-04-15T12:00:00Z", "boundary_at_to": "2026-04-15T12:00:00Z" }, "target_segment_id": "example" }'

Returns exact deduplication, privacy, overlap, and net-addition counts without mutation or usage. Requires ‘discovery’ scope.

collectionId
required
string
Media typeapplication/json
object
filters
object
providers
Array<string>
<= 20 items
connection_ids
Array<string>
<= 100 items
integration_run_ids
Array<string>
<= 100 items
source_kinds
Array<string>
<= 3 items
Allowed values: recurring batch file
boundary_at_from
string format: date-time
boundary_at_to
string format: date-time
target_segment_id
string

Exact materialization preview

Media typeapplication/json
object
cutoff_at
required
string format: date-time
preview
required
object
source_observations
required
integer
unique_identities
required
integer
duplicate_observations
required
integer
expired_identities
required
integer
suppressed_identities
required
integer
already_present
required
integer
net_additions
required
integer
Examplegenerated
{
"cutoff_at": "2026-04-15T12:00:00Z",
"preview": {
"source_observations": 1,
"unique_identities": 1,
"duplicate_observations": 1,
"expired_identities": 1,
"suppressed_identities": 1,
"already_present": 1,
"net_additions": 1
}
}

Invalid request — malformed body, missing required attribute, or failed validation. See error and message for details.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplevalidation_error
{
"error": "Bad Request",
"code": "MISSING_SEGMENTS",
"message": "segment_ids is required for filter audiences."
}

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
{
"error": "Unauthorized: Missing or invalid Authorization header"
}

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplemissing_scope
{
"error": "SCOPE_REQUIRED",
"message": "This endpoint requires the purchase scope."
}

Resource not found or not accessible to the calling org.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplenot_found
{
"error": "Audience not found"
}

Resource state conflicts with the request. For upload analysis this includes FILE_NOT_YET_UPLOADED.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examplegenerated
{
"error": "example",
"message": "example",
"code": "example",
"request_id": "example"
}