Skip to main content
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>"
  }
}
'
{
  "status": "<string>",
  "status_message": "<string>",
  "dfs": {
    "dupes": {
      "left": 1,
      "right": 1
    },
    "source_schemas": {
      "left": {
        "fields": [
          {
            "dtype": "<string>",
            "name": "<string>",
            "changes": "<unknown>",
            "metadata": "<unknown>"
          }
        ],
        "hash": "<string>",
        "metadata": "<unknown>"
      },
      "right": {
        "fields": [
          {
            "dtype": "<string>",
            "name": "<string>",
            "changes": "<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": "<unknown>",
    "summary": "<unknown>",
    "targets": [
      {
        "compare_method": "<string>",
        "left": "<string>",
        "right": "<string>"
      }
    ]
  },
  "messages": [
    {
      "description": "<string>",
      "level": "Info",
      "title": "<string>"
    }
  ],
  "oxen_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

base_head
string
required

The base and head revisions separated by '..'

Body

application/json

Tabular comparison information needed to fetch the correct cached diff (files, revisions)

compare
object[]
required
compare_id
string
required
display
object[]
required
keys
object[]
required
left
object
required
right
object
required

Response

Cached data frame diff found successfully

status
string
required
status_message
string
required
dfs
object
required
messages
object[]
required
oxen_version
string | null