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

# Controller Dataset Snapshot

`POST /dataset-snapshot`

## Request

- Base URL: `https://api.akkio.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.akkio.com/dataset-snapshot`
- Auth: none declared

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.dev/akkio/apis/akkio-api.md) - [All operations](https://skmtc.dev/akkio/apis/akkio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akkio/apis/akkio-api/revisions/c477deff6271?raw)