API Reference

Datasets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get dataset by ID

datasets.retrieve(id) -> Dataset { id, inserted_at, name, 6 more }

GET/api/v1/datasets/{id}

Get dataset by ID

ParametersExpand Collapse

id: String

ReturnsExpand Collapse

class 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

Get dataset by ID

Ruby

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

require "plaza"

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

dataset = plaza.datasets.retrieve("id")

puts(dataset)

200 example

{
  "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

200 example

{
  "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"
}