table-sources

Sample records before importing them

Fetch a page of records and report what is in them: the fields they carry, example values, and which identifier rows would be matched on across refreshes.

NOTHING is created here. Review it, then POST to the create endpoint.

fields merges what the sampled records actually contained with what the provider says a record of this type can carry, so a field every sampled record happens to leave empty is still offered.

post/table-sources/preview/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/table-sources/preview/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

integration_idstring uuid required

The connected integration to sample.

record_typestring required

Which object to sample.

Response

Successful Response

identity_fieldstring nullable required

The recommended key of the record's ids to match rows on across refreshes: one the tool sets itself where it says which those are. Null means the provider returned nothing usable, and the import cannot proceed.

identity_field_choicesstring[] required

Every id key rows could be matched on: present on all sampled records, and no two records share a value.

integration_idstring uuid required
integration_typestring required
record_typestring required
sample_recordsobject[] required

The sampled records themselves.

suggested_display_pathsstring[] required

Fields the create step would give their own column.

supports_incrementalboolean required

Whether the provider can return only records changed since a given time. When false every refresh re-lists everything.

Changes

No recorded changes to this operation across all 1 revision of this API.