Skip to main content
POST
/
datasets
Create a new dataset
curl --request POST \
  --url https://app.getcensus.com/api/v1/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Users",
  "type": "sql",
  "query": "SELECT id, name, email FROM users WHERE active = true",
  "source_id": 123,
  "description": "This dataset contains golden user records"
}
'
{
  "status": "created",
  "data": {
    "type": "sql",
    "query": "SELECT id, name, email FROM users WHERE active = true",
    "source_id": 123,
    "name": "Users",
    "id": 157,
    "resource_identifier": "dataset:users",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "This dataset contains golden user records",
    "cached_record_count": 123,
    "columns": [
      {
        "name": "email",
        "data_type": "string",
        "can_be_upsert_key": true
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Body

application/json
​
name
string
required

The name of the SQL dataset The name of the dataset

Example:

"Users"

​
type
enum<string>
default:sql
required

Type of dataset

Available options:
sql
​
query
string
required

SQL query that defines the dataset

Example:

"SELECT id, name, email FROM users WHERE active = true"

​
source_id
integer
required

ID of the source connection to run the query against

Example:

123

​
description
string

Optional description of the dataset Optional description of the dataset

Example:

"This dataset contains golden user records"

Response

Dataset created successfully

​
status
enum<string>

Outcome of the operation.

Available options:
success,
updated,
created,
not_found,
error
Example:

"created"

​
data
SQL · object