Skip to main content
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>'
{
  "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_type": "compare"
  },
  "resource": {
    "path": "<string>",
    "version": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
namespace
string
required

Namespace of the repository

​
repo_name
string
required

Name of the repository

​
compare_id
string
required

The unique ID of the comparison session

Query Parameters

​
page
integer

Page number for pagination (starts at 1)

Required range: x >= 0
​
page_size
integer

Page size for pagination

Required range: x >= 0

Response

Derived data frame found successfully

​
status
string
required
​
status_message
string
required
​
data_frame
object
required
​
oxen_version
string | null
​
commit
object
Example:
{
  "author": "ox",
  "email": "ox@example.com",
  "id": "a1b2c3d4e5f67890abcdef1234567890",
  "message": "Refactor data loading pipeline.",
  "parent_ids": ["f1e2d3c4b5a67890fedcba9876543210"],
  "timestamp": "2025-01-01T10:00:00Z"
}
​
derived_resource
object
​
resource
object