Get Derived Data Frame
curl --request GET \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff \
--header 'Authorization: Bearer <token>'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff', 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}/diff",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}/diff")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "<string>",
"status_message": "<string>",
"data_frame": {
"source": {
"schema": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
},
"size": {
"height": 1,
"width": 1
}
},
"view": {
"opts": [
{
"name": "<string>",
"value": "<unknown>"
}
],
"data": "<unknown>",
"pagination": {
"page_number": 1,
"page_size": 1,
"total_entries": 1,
"total_pages": 1
},
"schema": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
},
"size": {
"height": 1,
"width": 1
}
}
},
"oxen_version": "<string>",
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"derived_resource": {
"path": "<string>",
"resource_id": "<string>"
},
"resource": {
"path": "<string>",
"version": "<string>"
}
}Compare
Get Derived Data Frame
Get the derived diff data frame rows with pagination and optional filtering.
GET
/
api
/
repos
/
{namespace}
/
{repo_name}
/
compare
/
data_frames
/
{compare_id}
/
diff
Get Derived Data Frame
curl --request GET \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff \
--header 'Authorization: Bearer <token>'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff', 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}/diff",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}/diff")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/data_frames/{compare_id}/diff")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "<string>",
"status_message": "<string>",
"data_frame": {
"source": {
"schema": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
},
"size": {
"height": 1,
"width": 1
}
},
"view": {
"opts": [
{
"name": "<string>",
"value": "<unknown>"
}
],
"data": "<unknown>",
"pagination": {
"page_number": 1,
"page_size": 1,
"total_entries": 1,
"total_pages": 1
},
"schema": {
"fields": [
{
"dtype": "<string>",
"name": "<string>",
"changes": {
"status": "<string>",
"previous": {
"dtype": "<string>",
"name": "<string>",
"metadata": "<unknown>"
}
},
"metadata": "<unknown>"
}
],
"hash": "<string>",
"metadata": "<unknown>"
},
"size": {
"height": 1,
"width": 1
}
}
},
"oxen_version": "<string>",
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"derived_resource": {
"path": "<string>",
"resource_id": "<string>"
},
"resource": {
"path": "<string>",
"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
Query Parameters
Page number for pagination (starts at 1)
Required range:
x >= 0Page size for pagination
Required range:
x >= 0Response
Derived data frame found successfully
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
{
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": ["f1e2d3c4b5a67890fedcba9876543210"],
"timestamp": "2025-01-01T10:00:00Z"
}
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I