---
title: "Controller Dataset Snapshot"
method: POST
path: "/dataset-snapshot"
---

# Controller Dataset Snapshot

`POST /dataset-snapshot`

Dataset snapshot, used to get a preview of the data. Often used by the frontend as a proxy for whether a parse is through or not as well.

## Request body

- DatasetSnapshotRequest
  - `datasetId` string — The ID of the dataset you'd like to retrieve the snapshot of.
  - `filter` object
  - `sort` SortOrder
    - `sortField` string, required
    - `sortDirection` string, required
  - `make_download` boolean
  - `regenerate` boolean
  - `projectId` string, nullable
  - `templateId` string, nullable

## Response `201`

Successful Response

- unknown

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/akkio/apis/fastapi.md) · [All operations](https://skmtc.net/akkio/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akkio/fastapi/versions/6662a407c637/schema)