Skip to main content
GET
List the fields a table's imported rows could be matched on

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Response

Successful Response

available
boolean
required

Whether the table can switch to it now.

current
boolean
required

Whether the rows are matched on it now.

editable
boolean | null
required

True when people can edit this field in the tool, so an edited record comes back as a new row; false when the tool sets it and it never changes; null when the tool does not say.

field
string
required

The key, as the tool names it. Send it as identity_field.

filled
integer
required

How many sampled records carry a value for it.

problem
enum<string> | null
required

Why the table cannot switch to it: missing (some records or rows have no value), shared (two hold the same one) or inexact (the rows store it in a form a refresh cannot match exactly). Null when it can.

Available options:
missing,
shared,
inexact

Whether it is the key a new import from this tool would pick.

rows
integer
required

Rows in the table that came from the tool.

rows_missing
integer
required

Of those, rows whose stored record has no value for it.

rows_shared
integer
required

Of those, rows whose value another row also has.

sampled
integer
required

How many of the tool's records were just sampled.

unique
boolean
required

Whether no two different sampled records share a value.