Skip to content
GuidesBlogPlaygroundDashboard

Get dataset by ID

$client->datasets->retrieve(string id): Dataset
GET/api/v1/datasets/{id}

Get dataset by ID

ParametersExpand Collapse
id: string
ReturnsExpand Collapse
string id

Dataset UUID

\Datetime insertedAt

Creation timestamp (UTC)

string name

Human-readable dataset name

string slug

URL-friendly identifier

\Datetime updatedAt

Last update timestamp (UTC)

?string attribution

Required attribution text

?string description

Dataset description

?string license

License identifier (e.g. CC-BY-4.0)

?string sourceURL

URL of the original data source

Get dataset by ID

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'local');

$dataset = $client->datasets->retrieve('id');

var_dump($dataset);
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "NYC Bike Lanes",
  "slug": "nyc-bike-lanes",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "https://example.com"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "NYC Bike Lanes",
  "slug": "nyc-bike-lanes",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "https://example.com"
}