Skip to content
GuidesPlaygroundDashboard

Get dataset by ID

$ plaza datasets retrieve
GET/api/v1/datasets/{id}

Get dataset by ID

ParametersExpand Collapse
--id: string

Dataset ID

ReturnsExpand Collapse
dataset: object { id, inserted_at, name, 6 more }
id: string

Dataset ID

inserted_at: string

Creation timestamp

name: string

Dataset name

slug: string

URL-friendly slug

updated_at: string

Last update timestamp

attribution: optional string

Attribution text

description: optional string

Dataset description

license: optional string

License identifier

source_url: optional string

Source data URL

Get dataset by ID

plaza datasets retrieve \
  --api-key 'My API Key' \
  --id id
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "source_url"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "source_url"
}