Skip to main content
POST
Preview how a link to another table would match

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

A link as it is being set up, to see how it would match before it is saved.

keys
ReferenceKeyInputSchema · object[]
required

The pairs to match on, tried in order.

Required array length: 1 - 3 elements
target_table_id
string<uuid>
required

The table each row would point into.

label_column_id
string<uuid> | null

The other table's column each matched row is shown by.

Response

Successful Response

How a link's pairs would match this table's first rows.

error
string | null
required

Why nothing can match as set up, in a sentence to show; null otherwise.

matched
integer
required

Of those, the rows that would point at a row there.

rows_read
integer
required

The rows of this table read, from the top.

unmatched
integer
required

Rows with a value the other table does not hold.

unmatched_examples
string[]
required

Up to five of this table's values that matched nothing, as typed.

without_key
integer
required

Rows with nothing in any column matched on.