Skip to main content
Get a dataset's schema

Authorizations

Authorization
string
header
required

An API key from Settings, API keys, with the feeds scope.

Path Parameters

datasetId
string
required

Query Parameters

version
integer

A dataset version. Defaults to the current one.

Required range: x >= 1

Response

The schema.

datasetId
string
required
schemaVersion
string
required

MAJOR.MINOR. MINOR goes up for additive changes; MAJOR for changes that can break a consumer.

Example:

"2.1"

firstVersion
integer
required

The first dataset version with this schema.

columns
object[]
required
keyColumns
string[]
required
envelopeColumns
object[]

The _ploti_ columns every file carries.

changeFromPrevious
object | null