Skip to main content
GET
Preview rule data

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

dq_id
string<uuid>
required

The unique ID of the rule to preview data for.

Query Parameters

custom_sql
string | null

Optional SQL to run instead of the default failing-rows preview

Response

Preview data returned.

start
integer
required

The starting offset for pagination when returning a subset of the dataset.

row_count
integer
required

The number of rows included in the current response.

columns
string[]
required

A list of column names representing the structure of the returned dataset.

next_start
integer | null

The offset value for the next page of data, if additional results are available.

data
any[][] | null

The actual tabular data returned, where each inner list represents a row of values.