Skip to main content
POST
Preview a query

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

key
string
required

The integration key, such as snowflake or salesforce

Body

application/json
query
IntegrationQueryFields · object | null

A draft query to preview, not saved

query_id
string | null

A saved query to preview

Response

200 - application/json

Successful Response

duration_ms
integer
required
invalid
integer
required

Rows the query's validators drop

matched
integer
required

Rows that found their account (or person) and would write

rows_read
integer
required
samples
IntegrationPreviewSample · object[]
required

Up to 10 rows that would write

truncated
boolean
required

The query matched more than the 1,000 rows a preview reads

unmatched
integer
required

Rows that found no account (or person): a run skips them

unmatched_samples
any[]
required

Up to 10 of the values that matched no account

window_end
string<date-time> | null
required
window_start
string<date-time> | null
required

The window a run would cover now; null for custom objects