Skip to main content
GET
Get dataset schema

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dataset_id
string<uuid>
required

Dataset UUID

Query Parameters

version
string

Read the dataset as of one committed version instead of as it stands now.

Accepts a per-dataset version counter (?version=3), a tag (?version=golden), or a tag:-prefixed tag to force a numeric value to be read as a tag (?version=tag:3). A value made entirely of digits is a counter; anything else is a tag. There is deliberately no fallback between the two — ?version=3 never tries the tag 3 after failing to find counter 3 — so the same URL always addresses the same version.

Only committed versions resolve. Anything unresolvable is a 404, and that 404 is deliberately identical for "no such version" and "that version exists but is not committed", so it cannot leak a write in flight.

Omitting the parameter reads the dataset as it stands now.

Response

Dataset schema per bucket

Response object for standard API responses.

api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
data
object

Schema of existing dataset items. Each bucket maps field keys to their coverage count and inferred type. Empty objects indicate no items exist for that bucket or no keys were found within it.