Get a cached tabular data frame diff
curl --request GET \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"compare": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"compare_id": "<string>",
"display": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"keys": [
{
"left": "<string>",
"right": "<string>",
"alias_as": "<string>",
"compare_method": "<string>"
}
],
"left": {
"path": "<string>",
"version": "<string>"
},
"right": {
"path": "<string>",
"version": "<string>"
}
}
'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}"
payload = {
"compare": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"compare_id": "<string>",
"display": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"keys": [
{
"left": "<string>",
"right": "<string>",
"alias_as": "<string>",
"compare_method": "<string>"
}
],
"left": {
"path": "<string>",
"version": "<string>"
},
"right": {
"path": "<string>",
"version": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
compare: [{compare_method: '<string>', left: '<string>', right: '<string>'}],
compare_id: '<string>',
display: [{compare_method: '<string>', left: '<string>', right: '<string>'}],
keys: [
{
left: '<string>',
right: '<string>',
alias_as: '<string>',
compare_method: '<string>'
}
],
left: {path: '<string>', version: '<string>'},
right: {path: '<string>', version: '<string>'}
})
};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}', 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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'compare' => [
[
'compare_method' => '<string>',
'left' => '<string>',
'right' => '<string>'
]
],
'compare_id' => '<string>',
'display' => [
[
'compare_method' => '<string>',
'left' => '<string>',
'right' => '<string>'
]
],
'keys' => [
[
'left' => '<string>',
'right' => '<string>',
'alias_as' => '<string>',
'compare_method' => '<string>'
]
],
'left' => [
'path' => '<string>',
'version' => '<string>'
],
'right' => [
'path' => '<string>',
'version' => '<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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}"
payload := strings.NewReader("{\n \"compare\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"compare_id\": \"<string>\",\n \"display\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"keys\": [\n {\n \"left\": \"<string>\",\n \"right\": \"<string>\",\n \"alias_as\": \"<string>\",\n \"compare_method\": \"<string>\"\n }\n ],\n \"left\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n },\n \"right\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("GET", 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.get("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"compare\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"compare_id\": \"<string>\",\n \"display\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"keys\": [\n {\n \"left\": \"<string>\",\n \"right\": \"<string>\",\n \"alias_as\": \"<string>\",\n \"compare_method\": \"<string>\"\n }\n ],\n \"left\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n },\n \"right\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"compare\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"compare_id\": \"<string>\",\n \"display\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"keys\": [\n {\n \"left\": \"<string>\",\n \"right\": \"<string>\",\n \"alias_as\": \"<string>\",\n \"compare_method\": \"<string>\"\n }\n ],\n \"left\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n },\n \"right\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"status_message": "<string>",
"dfs": {
"dupes": {
"left": 1,
"right": 1
},
"source_schemas": {
"left": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
},
"right": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
}
},
"display": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"keys": [
{
"left": "<string>",
"right": "<string>",
"alias_as": "<string>",
"compare_method": "<string>"
}
],
"schema_diff": {
"added_cols": [
{
"dtype": "<string>",
"key": "<string>",
"name": "<string>"
}
],
"removed_cols": [
{
"dtype": "<string>",
"key": "<string>",
"name": "<string>"
}
]
},
"summary": {
"modifications": {
"added_rows": 1,
"modified_rows": 1,
"removed_rows": 1
},
"schema": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
}
},
"targets": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
]
},
"messages": [
{
"description": "<string>",
"title": "<string>"
}
],
"oxen_version": "<string>"
}Data Frames
Get a cached tabular data frame diff
Retrieve a previously cached tabular diff by its comparison ID.
GET
/
api
/
repos
/
{namespace}
/
{repo_name}
/
compare
/
data_frames
/
{compare_id}
Get a cached tabular data frame diff
curl --request GET \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"compare": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"compare_id": "<string>",
"display": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"keys": [
{
"left": "<string>",
"right": "<string>",
"alias_as": "<string>",
"compare_method": "<string>"
}
],
"left": {
"path": "<string>",
"version": "<string>"
},
"right": {
"path": "<string>",
"version": "<string>"
}
}
'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}"
payload = {
"compare": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"compare_id": "<string>",
"display": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"keys": [
{
"left": "<string>",
"right": "<string>",
"alias_as": "<string>",
"compare_method": "<string>"
}
],
"left": {
"path": "<string>",
"version": "<string>"
},
"right": {
"path": "<string>",
"version": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
compare: [{compare_method: '<string>', left: '<string>', right: '<string>'}],
compare_id: '<string>',
display: [{compare_method: '<string>', left: '<string>', right: '<string>'}],
keys: [
{
left: '<string>',
right: '<string>',
alias_as: '<string>',
compare_method: '<string>'
}
],
left: {path: '<string>', version: '<string>'},
right: {path: '<string>', version: '<string>'}
})
};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}', 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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'compare' => [
[
'compare_method' => '<string>',
'left' => '<string>',
'right' => '<string>'
]
],
'compare_id' => '<string>',
'display' => [
[
'compare_method' => '<string>',
'left' => '<string>',
'right' => '<string>'
]
],
'keys' => [
[
'left' => '<string>',
'right' => '<string>',
'alias_as' => '<string>',
'compare_method' => '<string>'
]
],
'left' => [
'path' => '<string>',
'version' => '<string>'
],
'right' => [
'path' => '<string>',
'version' => '<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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}"
payload := strings.NewReader("{\n \"compare\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"compare_id\": \"<string>\",\n \"display\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"keys\": [\n {\n \"left\": \"<string>\",\n \"right\": \"<string>\",\n \"alias_as\": \"<string>\",\n \"compare_method\": \"<string>\"\n }\n ],\n \"left\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n },\n \"right\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("GET", 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.get("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"compare\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"compare_id\": \"<string>\",\n \"display\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"keys\": [\n {\n \"left\": \"<string>\",\n \"right\": \"<string>\",\n \"alias_as\": \"<string>\",\n \"compare_method\": \"<string>\"\n }\n ],\n \"left\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n },\n \"right\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"compare\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"compare_id\": \"<string>\",\n \"display\": [\n {\n \"compare_method\": \"<string>\",\n \"left\": \"<string>\",\n \"right\": \"<string>\"\n }\n ],\n \"keys\": [\n {\n \"left\": \"<string>\",\n \"right\": \"<string>\",\n \"alias_as\": \"<string>\",\n \"compare_method\": \"<string>\"\n }\n ],\n \"left\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n },\n \"right\": {\n \"path\": \"<string>\",\n \"version\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"status_message": "<string>",
"dfs": {
"dupes": {
"left": 1,
"right": 1
},
"source_schemas": {
"left": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
},
"right": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
}
},
"display": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
],
"keys": [
{
"left": "<string>",
"right": "<string>",
"alias_as": "<string>",
"compare_method": "<string>"
}
],
"schema_diff": {
"added_cols": [
{
"dtype": "<string>",
"key": "<string>",
"name": "<string>"
}
],
"removed_cols": [
{
"dtype": "<string>",
"key": "<string>",
"name": "<string>"
}
]
},
"summary": {
"modifications": {
"added_rows": 1,
"modified_rows": 1,
"removed_rows": 1
},
"schema": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
}
},
"targets": [
{
"compare_method": "<string>",
"left": "<string>",
"right": "<string>"
}
]
},
"messages": [
{
"description": "<string>",
"title": "<string>"
}
],
"oxen_version": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Namespace of the repository
Name of the repository
The unique ID of the comparison session
The base and head revisions separated by '..'
Body
application/json
Tabular comparison information needed to fetch the correct cached diff (files, revisions)
⌘I