Skip to documentation content
Dataset APIDocs

Datasets and schemas

Discover dataset definitions and build stable downstream schemas.

In this guide
  1. 1Discover catalogs
  2. 2Read field contracts
  3. 3Preserve row identity
In this guide
  1. 1Discover catalogs
  2. 2Read field contracts
  3. 3Preserve row identity

Discover instead of hard-coding

GET /datasets returns the catalogs visible to the credential. Use the dataset id as the stable integration key; treat the human-readable name and description as display copy.

GET /v1/datasets

Inspect the dataset definition

GET /v1/datasets/{dataset_id}

Read version, row_entity_type, market, language, jurisdiction, fields, identity_fields, latest_release, and release_count before accepting a catalog in production.

Field descriptors

PropertyMeaning
nameField name in query and download rows
typeLogical scalar type
formatOptional semantic format such as date-time
unitOptional measurement or currency unit
requiredWhether every conforming row must contain the field

Preserve source identity

identity_fields define the source-level key used to reconcile records. Store them even if your application also creates its own surrogate key. A dataset_row_id may identify the normalized row, while source identity lets you trace it back to the originating listing.

Handle compatible schema evolution

Was this page helpful?