Retrieve a Dataset

Returns details on the dataset in JSON format.

Methods

GET /datasets/{owner}/{id}

Path parameters

Parameter Description Data Type
owner Dataset owner username. Included in data.world dataset URL path, after domain.
For example, jonloyens in https://data.world/jonloyens/an-intro-to-dataworld-dataset		 string
id Dataset id. Included in data.world dataset URL, after owner's username.
For example, an-intro-to-dataworld-dataset in https://data.world/jonloyens/an-intro-to-dataworld-dataset		 string

Response

Response JSON schema (Status 200)

{
  "owner": "string",
  "id": "string",
  "title": "string",
  "description": "string",
  "summary": "string",
  "tags": [
    "string"
  ],
  "license": "string",
  "visibility": "string",
  "files": [
    {
      "name": "string",
      "sizeInBytes": 0,
      "source": {
        "id": "string",
        "url": "string",
        "syncStatus": "string",
        "syncSummary": "string",
        "lastSyncStart": "string",
        "lastSyncSuccess": "string",
        "lastSyncFailure": "string"
      },
      "created": "string",
      "updated": "string",
      "description": "string",
      "labels": [
       "string"
      ]
    }
  ],
  "status": "string",
  "created": "string",
  "updated": "string"
}

Response parameters

Name Type Description
owner string Dataset owner name.
id string Dataset id.
title string Dataset name. 3 to 30 characters.
description string Short description for dataset. Max. 120 characters.
summary string Dataset summary, markdown supported. Max. 25,000 characters.
tags array Array of strings to tag dataset.
2 to 25 characters each. Letters, numbers and spaces only.
{ "tags": [ "tag1", "tag2" ]}
license string Public Domain, PDDL, CC-0, CC-BY, ODC-BY, CC-BY-SA, ODC-ODbL, CC BY-NC-SA or Other
See full descriptions
visibility string OPEN or PRIVATE
files object List of files and their sources to add to dataset.
status string Dataset status on data.world.
NEW: dataset created, pending first file ingest.
INPROGRESS: file ingest is in progress.
LOADED: file ingest complete.
SYSTEMERROR: file ingest failed. Contact help@data.world
created string Date the dataset was created.
updated string Date the dataset was last modified.

The files object contains the following keys:

Name Type Description
name string The filename including the file extension.
sizeInBytes integer Size of the file in bytes.
source object List of file URLs.
created string Date the file was created.
updated string Date the file was last modified.
description string Short description for the file. Max. 120 characters.
labels array Array of strings to label file. Acceptable string values are: raw data, clean data, documentation, script, visualization, and report.
{ "labels": [ "raw data", "report" ]}

The source object contains the following keys:

Name Type Description
id string The file ID.
url string The source URL for each file.
syncStatus string File status on data.world.
NEW: a sync has never been attempted.
INPROGRESS: a sync is currently in progress.
OK: the most recent sync completed normally.
SYSTEMERROR: the most recent sync failed. Contact help@data.world
syncSummary string
lastSyncStart string The last time a sync was started for the file.
lastSyncSuccess string The last time a sync was successfully completed.
lastSyncFailure string The last time a sync failed for the file.

Errors

HTTP Status Code Reason Solution
400 Bad request. Check syntax and URIs.
401 Unauthorized Verify credentials / API key
403 Forbidden
404 Not found.
422 Bad request. Check syntax and URIs.
500 Server error.

Error Response Model:

{
  "code": 0,
  "message": "string",
  "details": "string"
}

EXAMPLE

Request URL:

https://api.data.world/v0/datasets/sya/trumpworld

cURL:

$ curl https://api.data.world/v0/datasets/sya/trumpworld?authentication=Bearer+<API_TOKEN>

Response Body:

{
  "owner": "sya",
  "id": "trumpworld",
  "title": "TrumpWorld",
  "description": "TrumpWorld Data",
  "summary": "From the Buzzfeed article [Help Us Map TrumpWorld](https://www.buzzfeed.com/johntemplon/help-us-map-trumpworld)\n>No American president has taken office with a giant network of businesses, investments, and corporate connections like that amassed by Donald J. Trump. His family and advisers have touched a staggering number of ventures, from a hotel in Azerbaijan to a poker company in Las Vegas.\n\n\nCheck out the data.world docs on how to Upload & sync files from [**Google Sheets**](https://docs.data.world/documentation/api/googleSync.html) and [**Github**](https://docs.data.world/documentation/api/githubSync.html)   \n\n\nSource: [github.com/BuzzFeedNews](https://github.com/BuzzFeedNews/trumpworld/tree/master/data)   \n\n_If you have suggestions for expanding or improving the dataset, please email trump@buzzfeed.com. If you’d like to send your tip securely and anonymously, see these [instructions](https://tips.buzzfeed.com/)._",
  "tags": [
    "trump",
    "trump world",
    "president",
    "connections",
    "swamp",
    "business network"
  ],
  "visibility": "OPEN",
  "files": [
    {
      "name": "org-org-connections.csv",
      "sizeInBytes": 97658,
      "source": {
        "id": "bfbac3bb-9cec-410a-9ac4-c904a56d65fe",
        "url": "https://raw.githubusercontent.com/BuzzFeedNews/trumpworld/master/data/org-org-connections.csv",
        "syncStatus": "OK",
        "lastSyncStart": "2017-02-06T22:55:15.242Z",
        "lastSyncSuccess": "2017-02-06T22:55:15.258Z",
        "lastSyncFailure": "2017-02-01T23:47:47.667Z"
      },
      "created": "2017-02-01T23:45:12.379Z",
      "updated": "2017-02-03T16:05:03.241Z"
    },
    {
      "name": "person-org-connections.csv",
      "sizeInBytes": 231637,
      "source": {
        "id": "91cf66e3-4bd7-422f-a8ec-7de1b68f8ee1",
        "url": "https://raw.githubusercontent.com/BuzzFeedNews/trumpworld/master/data/person-org-connections.csv",
        "syncStatus": "OK",
        "lastSyncStart": "2017-02-06T22:55:15.242Z",
        "lastSyncSuccess": "2017-02-06T22:55:15.310Z"
      },
      "created": "2017-02-01T23:51:02.777Z",
      "updated": "2017-02-03T16:05:03.241Z"
    },
    {
      "name": "person-person-connections.csv",
      "sizeInBytes": 32556,
      "source": {
        "id": "b1e0659b-c282-408a-893a-14b5e5a1ae4c",
        "url": "https://raw.githubusercontent.com/BuzzFeedNews/trumpworld/master/data/person-person-connections.csv",
        "syncStatus": "OK",
        "lastSyncStart": "2017-02-06T22:55:15.242Z",
        "lastSyncSuccess": "2017-02-06T22:55:15.361Z"
      },
      "created": "2017-02-01T23:51:32.492Z",
      "updated": "2017-02-03T16:05:03.241Z"
    }
  ],
  "status": "LOADED",
  "created": "2017-02-01T22:33:58.809Z",
  "updated": "2017-02-06T22:55:19.128Z"
}

results matching ""

    No results matching ""