Skip to content
GuidesPlaygroundDashboard

List all datasets

datasets.list() -> DatasetList { datasets }
GET/api/v1/datasets

List all datasets

ReturnsExpand Collapse
class DatasetList { datasets }
datasets: Array[Dataset { id, inserted_at, name, 6 more } ]
id: String

Dataset ID

formatuuid
inserted_at: Time

Creation timestamp

formatdate-time
name: String

Dataset name

slug: String

URL-friendly slug

updated_at: Time

Last update timestamp

formatdate-time
attribution: String

Attribution text

description: String

Dataset description

license: String

License identifier

source_url: String

Source data URL

List all datasets

require "plaza"

plaza = Plaza::Client.new(
  api_key: "My API Key",
  environment: "local" # defaults to "production"
)

dataset_list = plaza.datasets.list

puts(dataset_list)
{
  "datasets": [
    {
      "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
{
  "datasets": [
    {
      "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"
    }
  ]
}