Sample records before importing them

curl --request POST \
  --url https://api.getoneprofile.ai/table-sources/preview/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record_type": "<string>"
}
'

import requests

url = "https://api.getoneprofile.ai/table-sources/preview/"

payload = {
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    record_type: '<string>'
  })
};

fetch('https://api.getoneprofile.ai/table-sources/preview/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getoneprofile.ai/table-sources/preview/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'record_type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getoneprofile.ai/table-sources/preview/"

	payload := strings.NewReader("{\n  \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_type\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/table-sources/preview/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/table-sources/preview/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "fields": [
    {
      "declared": true,
      "label": "<string>",
      "path": "<string>",
      "property_type": "string",
      "sample_value": "<string>"
    }
  ],
  "identity_field": "<string>",
  "identity_field_choices": [
    "<string>"
  ],
  "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "integration_type": "<string>",
  "record_type": "<string>",
  "sample_records": [
    {}
  ],
  "suggested_display_paths": [
    "<string>"
  ],
  "supports_incremental": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

Sample records before importing them

curl --request POST \
  --url https://api.getoneprofile.ai/table-sources/preview/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record_type": "<string>"
}
'

import requests

url = "https://api.getoneprofile.ai/table-sources/preview/"

payload = {
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_type": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    record_type: '<string>'
  })
};

fetch('https://api.getoneprofile.ai/table-sources/preview/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getoneprofile.ai/table-sources/preview/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'record_type' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getoneprofile.ai/table-sources/preview/"

	payload := strings.NewReader("{\n  \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_type\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/table-sources/preview/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/table-sources/preview/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"record_type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "fields": [
    {
      "declared": true,
      "label": "<string>",
      "path": "<string>",
      "property_type": "string",
      "sample_value": "<string>"
    }
  ],
  "identity_field": "<string>",
  "identity_field_choices": [
    "<string>"
  ],
  "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "integration_type": "<string>",
  "record_type": "<string>",
  "sample_records": [
    {}
  ],
  "suggested_display_paths": [
    "<string>"
  ],
  "supports_incremental": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

What to sample.

integration_id

string<uuid>

required

The connected integration to sample.

record_type

string

required

Which object to sample.

Required string length: 1 - 255

Response

Successful Response

A sample of the records an import would bring in, and the fields inside them.

Nothing is created here: no table, no column, no row. Review it, then POST to the create endpoint to build the table.

fields

SourceFieldSchema · object[]

required

Sampled and declared fields.

Show child attributes

identity_field

string | null

required

Which key of the record's ids the rows would be matched on across refreshes. Null means the provider returned nothing usable, and the import cannot proceed.

identity_field_choices

string[]

required

Every id key present on all sampled records.

integration_id

string<uuid>

required

integration_type

string

required

record_type

string

required

sample_records

Sample Records · object[]

required

The sampled records themselves.

suggested_display_paths

string[]

required

Fields the create step would give their own column.

supports_incremental

boolean

required

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

API reference

Endpoints

Sample records before importing them

Authorizations

Body

Response