---
title: "Get data frame slice"
method: GET
path: "/api/repos/{namespace}/{repo_name}/data_frames/{resource}"
tags: ["Data Frames"]
---

# Get data frame slice

`GET /api/repos/{namespace}/{repo_name}/data_frames/{resource}`

## Request

- Base URL: `https://hub.oxen.ai`
- URL: `https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/{resource}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/oxen/apis/oxen-server/docs/api/repos/:namespace/:repo_name/data_frames/:resource/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a paginated slice of a tabular data frame with optional filtering and transformations.

## Path parameters

- `namespace` string, required
- `repo_name` string, required
- `resource` string, required
- `columns` string, nullable, required
- `delimiter` string, nullable, required
- `find_embedding_where` string, nullable, required
- `filter` string, nullable, required
- `output` string, nullable, required
- `output_column` string, nullable, required
- `page_size` integer, nullable, required
- `page` integer, nullable, required
- `row` integer, nullable, required
- `randomize` boolean, nullable, required
- `reverse` boolean, nullable, required
- `slice` string, nullable, required
- `sort_by` string, nullable, required
- `sort_by_similarity_to` string, nullable, required
- `sql` string, nullable, required
- `take` string, nullable, required

## Response `200`

Data frame slice found

- JsonDataFrameViewResponse
  - `oxen_version` string, nullable
  - `status` string, required
  - `status_message` string, required
  - `commit` Commit
    - `author` string, required
    - `email` string, required
    - `id` string, required
    - `message` string, required
    - `parent_ids` string[], required
    - `timestamp` string, date-time, required
  - `data_frame` JsonDataFrameViews, required
    - `source` DataFrameSchemaSize, required
      - `schema` Schema, required
        - `fields` Field[], required
          - `changes` Changes
            - `previous` PreviousField
              - …
            - `status` string, required
          - `dtype` string, required
          - `metadata` unknown
          - `name` string, required
        - `hash` string, required
        - `metadata` unknown
      - `size` DataFrameSize, required
        - `height` integer, required
        - `width` integer, required
    - `view` JsonDataFrameView, required
      - `opts` DFOptView[], required
        - `name` string, required
        - `value` unknown, required
      - `data` unknown, required
      - `pagination` Pagination, required
        - `page_number` integer, required
        - `page_size` integer, required
        - `total_entries` integer, required
        - `total_pages` integer, required
      - `schema` Schema, required
        - `fields` Field[], required
          - `changes` Changes
            - `previous` PreviousField
              - …
            - `status` string, required
          - `dtype` string, required
          - `metadata` unknown
          - `name` string, required
        - `hash` string, required
        - `metadata` unknown
      - `size` DataFrameSize, required
        - `height` integer, required
        - `width` integer, required
  - `derived_resource` DerivedDFResource
    - `path` string, required
    - `resource_id` string, required
    - `resource_type` 'compare' | 'diff' | 'query', required
  - `resource` ResourceVersion
    - `path` string, required
    - `version` string, required

## Other responses

- `404`: File or resource not found

---

[API](https://skmtc.dev/oxen/apis/oxen-server.md) - [All operations](https://skmtc.dev/oxen/apis/oxen-server/llms.txt) - [OpenAPI document](https://skmtc.dev/oxen/apis/oxen-server/revisions/2ae578129949?raw)