Skip to content
GuidesPlaygroundDashboard

Create a new dataset (admin only)

$ plaza datasets create
POST/api/v1/datasets

Create a new dataset (admin only)

ParametersExpand Collapse
--name: string

Dataset name

--slug: string

URL-friendly slug

--attribution: optional string

Attribution text

--description: optional string

Dataset description

--license: optional string

License identifier

--source-url: optional string

Source data URL

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

Create a new dataset (admin only)

plaza datasets create \
  --api-key 'My API Key' \
  --name name \
  --slug slug
{
  "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"
}