Upsert Dataset - TrueState Documentation

Upsert Dataset

curl --request POST \
  --url https://api.example.com/datasets/upsert/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": "[{ \"customer_id\": 1,  \"name\": \"Alice Johnson\" }, { \"customer_id\": 2,  \"name\": \"Brandon Lee\" },]",
  "dataset_name": "customers",
  "row_unique_identifier": "customer_id"
}
'

import requests

url = "https://api.example.com/datasets/upsert/"

payload = {
    "data": "[{ \"customer_id\": 1,  \"name\": \"Alice Johnson\" }, { \"customer_id\": 2,  \"name\": \"Brandon Lee\" },]",
    "dataset_name": "customers",
    "row_unique_identifier": "customer_id"
}
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({
    data: '[{ "customer_id": 1,  "name": "Alice Johnson" }, { "customer_id": 2,  "name": "Brandon Lee" },]',
    dataset_name: 'customers',
    row_unique_identifier: 'customer_id'
  })
};

fetch('https://api.example.com/datasets/upsert/', 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.example.com/datasets/upsert/",
  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([
    'data' => '[{ "customer_id": 1,  "name": "Alice Johnson" }, { "customer_id": 2,  "name": "Brandon Lee" },]',
    'dataset_name' => 'customers',
    'row_unique_identifier' => 'customer_id'
  ]),
  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.example.com/datasets/upsert/"

	payload := strings.NewReader("{\n  \"data\": \"[{ \\\"customer_id\\\": 1,  \\\"name\\\": \\\"Alice Johnson\\\" }, { \\\"customer_id\\\": 2,  \\\"name\\\": \\\"Brandon Lee\\\" },]\",\n  \"dataset_name\": \"customers\",\n  \"row_unique_identifier\": \"customer_id\"\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.example.com/datasets/upsert/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": \"[{ \\\"customer_id\\\": 1,  \\\"name\\\": \\\"Alice Johnson\\\" }, { \\\"customer_id\\\": 2,  \\\"name\\\": \\\"Brandon Lee\\\" },]\",\n  \"dataset_name\": \"customers\",\n  \"row_unique_identifier\": \"customer_id\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/datasets/upsert/")

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  \"data\": \"[{ \\\"customer_id\\\": 1,  \\\"name\\\": \\\"Alice Johnson\\\" }, { \\\"customer_id\\\": 2,  \\\"name\\\": \\\"Brandon Lee\\\" },]\",\n  \"dataset_name\": \"customers\",\n  \"row_unique_identifier\": \"customer_id\"\n}"

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

{}

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

POST

/

datasets

/

upsert

/

Upsert Dataset

curl --request POST \
  --url https://api.example.com/datasets/upsert/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": "[{ \"customer_id\": 1,  \"name\": \"Alice Johnson\" }, { \"customer_id\": 2,  \"name\": \"Brandon Lee\" },]",
  "dataset_name": "customers",
  "row_unique_identifier": "customer_id"
}
'

import requests

url = "https://api.example.com/datasets/upsert/"

payload = {
    "data": "[{ \"customer_id\": 1,  \"name\": \"Alice Johnson\" }, { \"customer_id\": 2,  \"name\": \"Brandon Lee\" },]",
    "dataset_name": "customers",
    "row_unique_identifier": "customer_id"
}
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({
    data: '[{ "customer_id": 1,  "name": "Alice Johnson" }, { "customer_id": 2,  "name": "Brandon Lee" },]',
    dataset_name: 'customers',
    row_unique_identifier: 'customer_id'
  })
};

fetch('https://api.example.com/datasets/upsert/', 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.example.com/datasets/upsert/",
  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([
    'data' => '[{ "customer_id": 1,  "name": "Alice Johnson" }, { "customer_id": 2,  "name": "Brandon Lee" },]',
    'dataset_name' => 'customers',
    'row_unique_identifier' => 'customer_id'
  ]),
  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.example.com/datasets/upsert/"

	payload := strings.NewReader("{\n  \"data\": \"[{ \\\"customer_id\\\": 1,  \\\"name\\\": \\\"Alice Johnson\\\" }, { \\\"customer_id\\\": 2,  \\\"name\\\": \\\"Brandon Lee\\\" },]\",\n  \"dataset_name\": \"customers\",\n  \"row_unique_identifier\": \"customer_id\"\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.example.com/datasets/upsert/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": \"[{ \\\"customer_id\\\": 1,  \\\"name\\\": \\\"Alice Johnson\\\" }, { \\\"customer_id\\\": 2,  \\\"name\\\": \\\"Brandon Lee\\\" },]\",\n  \"dataset_name\": \"customers\",\n  \"row_unique_identifier\": \"customer_id\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/datasets/upsert/")

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  \"data\": \"[{ \\\"customer_id\\\": 1,  \\\"name\\\": \\\"Alice Johnson\\\" }, { \\\"customer_id\\\": 2,  \\\"name\\\": \\\"Brandon Lee\\\" },]\",\n  \"dataset_name\": \"customers\",\n  \"row_unique_identifier\": \"customer_id\"\n}"

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

{}

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

Authorizations

Authorization

string

header

required

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

Headers

Api-key

string | null

Query Parameters

check_schema

boolean

default:true

Body

application/json

dataset_name

string

required

The name of the dataset to be inserted or updated.

row_unique_identifier

string

required

The column name that can uniquely identify the row in the dataset, normally an id column.

data

Data · object[]

required

The data rows in the format of list of json object, where each json object in the list is a single row. The json objects need to have identical top level fields. The max size is 1G.

data_schema

Data Schema · object | null

Optional. specify the schema in the 'data' field. It contains key value pairs of { column_name : column_type }. column_name is the top level field in the JSON objects, DO NOT provide the inner nested fields. Valid value for column types are: 'INTEGER', 'FLOAT', 'STRING', 'BOOLEAN': 'JSON'

Show child attributes

Response

Successful Response

The response is of type Response Upsert Dataset Datasets Upsert Post · object.