Preview a column definition
curl --request POST \
--url https://api.getoneprofile.ai/tables/{table_id}/columns/preview/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"default_value": "<string>",
"kind": "manual"
}
}
'import requests
url = "https://api.getoneprofile.ai/tables/{table_id}/columns/preview/"
payload = { "definition": {
"default_value": "<string>",
"kind": "manual"
} }
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({definition: {default_value: '<string>', kind: 'manual'}})
};
fetch('https://api.getoneprofile.ai/tables/{table_id}/columns/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/tables/{table_id}/columns/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([
'definition' => [
'default_value' => '<string>',
'kind' => 'manual'
]
]),
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/tables/{table_id}/columns/preview/"
payload := strings.NewReader("{\n \"definition\": {\n \"default_value\": \"<string>\",\n \"kind\": \"manual\"\n }\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/tables/{table_id}/columns/preview/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"default_value\": \"<string>\",\n \"kind\": \"manual\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/tables/{table_id}/columns/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 \"definition\": {\n \"default_value\": \"<string>\",\n \"kind\": \"manual\"\n }\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"error": "<string>",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<unknown>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}table-columns
Preview a column definition
Evaluate an unsaved definition over the table’s first rows. A formula definition evaluates over the first 25 rows with the same data-type derivation the save path uses. A Use AI definition runs the REAL pipeline over the first 3 rows, free of charge (a per-organisation daily allowance backstops abuse). Nothing is persisted and no run is requested. Manual definitions are rejected.
POST
/
tables
/
{table_id}
/
columns
/
preview
/
Preview a column definition
curl --request POST \
--url https://api.getoneprofile.ai/tables/{table_id}/columns/preview/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"default_value": "<string>",
"kind": "manual"
}
}
'import requests
url = "https://api.getoneprofile.ai/tables/{table_id}/columns/preview/"
payload = { "definition": {
"default_value": "<string>",
"kind": "manual"
} }
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({definition: {default_value: '<string>', kind: 'manual'}})
};
fetch('https://api.getoneprofile.ai/tables/{table_id}/columns/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/tables/{table_id}/columns/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([
'definition' => [
'default_value' => '<string>',
'kind' => 'manual'
]
]),
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/tables/{table_id}/columns/preview/"
payload := strings.NewReader("{\n \"definition\": {\n \"default_value\": \"<string>\",\n \"kind\": \"manual\"\n }\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/tables/{table_id}/columns/preview/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"default_value\": \"<string>\",\n \"kind\": \"manual\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/tables/{table_id}/columns/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 \"definition\": {\n \"default_value\": \"<string>\",\n \"kind\": \"manual\"\n }\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"error": "<string>",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<unknown>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
HTTPBearerAPIKeyHeader
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Request body for previewing an unsaved formula definition.
Definition of a manual column: typed, user-editable cells.
- ManualColumnDefinition
- FormulaColumnDefinition
- EnrichmentColumnDefinition
- SourceColumnDefinition
- ExportColumnDefinition
- SequenceColumnDefinition
Show child attributes
Show child attributes
Response
Successful Response
Preview results over the table's first rows; nothing is persisted.
Show child attributes
Show child attributes
Was this page helpful?