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

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>"
  }
}
'

200

{
  "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

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

Show child attributes

compare_id · string · required

display · object[] · required

Show child attributes

keys · object[] · required

Show child attributes

left · object · required

Show child attributes

right · object · required

Show child attributes

Response

200

application/json

Cached data frame diff found successfully

status · string · required

status_message · string · required

dfs · object · required

Show child attributes

messages · object[] · required

Show child attributes

oxen_version · string | null