post

Overview

This endpoint is used for creating new datasets. Datasets can belong to either a user or organization.

HTTP Request

POST /api/v1/users/:userName/datasets
POST /api/v1/organizations/:organizationName/datasets

This endpoint extends the general API structure

Path parameters

Parameter

userName

The user name of the user that owns the dataset

organizationName

The short name of the organization that owns the dataset

Request body

Provide a JSON object with information about the dataset.

Property name

Type

Description

name

string

Required. The name of the dataset. Must be unique (non-word characters ignored) within the user or organization that owns the dataset.

publicAccessLevel

string

Required. The public access level of the dataset. Must be one of:

  • none - Only specific people will be able to see the existence of the dataset.

  • overview - Anyone can see the existence of the dataset

  • metadata - Anyone can view any variables and summary statistics on the dataset.

  • sample - Anyone can view, query, and download the dataset's sample data.

  • data - Anyone can view, query, and download the dataset's data.

description

string

Optional. A short description of the dataset that will show up in search results. Limited to 256 characters.

Authorization

You must either authorize as the user or an administrator of the organization that owns the dataset. Your access token must have the following scope:

  • data.edit

Learn more about authorization.

Response body

Returns the JSON-encoded "get" representation of a dataset resource.