Create a new dataset
Create a new dataset in the current workspace. Supports SQL datasets.
Request schema
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
name
stringrequired
The name of the SQL dataset
example:
Users
type
stringrequired
sql
Type of dataset
default:
sql
enum:
"sql"
description
string
Optional description of the dataset
x-nullable:
true
example:
This dataset contains user data from our database
query
stringrequired
SQL query that defines the dataset
example:
SELECT id, name, email FROM users WHERE active = true
source_id
integerrequired
ID of the source connection to run the query against
example:
123
Http + 1.1
POST
https://app.getcensus.com/api/v1/datasets
POST /api/v1/datasets HTTP/1.1 Authorization: Bearer REPLACE_BEARER_TOKEN Content-Type: application/json Host: app.getcensus.com Content-Length: 196 { "name": "Users", "type": "sql", "description": "This dataset contains user data from our database", "query": "SELECT id, name, email FROM users WHERE active = true", "source_id": 123 }
Responses
201
Dataset created successfully
400
Bad Request
401
Invalid credentials for the requested resource.
403
The feature you're trying to use is not available for your organization.
201
status
string
Outcome of the operation.
enum:
"success""updated""created""not_found""error"
data
object
type
stringrequired
sql
Type of dataset
default:
sql
enum:
"sql"
query
stringrequired
SQL query that defines the dataset
example:
SELECT id, name, email FROM users WHERE active = true
source_id
integerrequired
ID of the source connection
example:
123
400
status
string
The outcome of the request
enum:
"error"
message
string
The reason the request failed
example:
param is missing or the value is empty: type
401
status
integer
HTTP status code.
enum:
"401"
403
status
integer
HTTP status code.
enum:
"403"
message
string
Error message.
example:
The feature you're trying to use is not available for your organization.
{ "status": "created", "data": { "type": "sql", "query": "SELECT id, name, email FROM users WHERE active = true", "source_id": 123 } }