Skip to navigation
Datasets

Update a dataset

View as Markdown

Requires edit access to the dataset. Visualizations built on the dataset plot the new query the next time they load.

Requires an API key with the write scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

dataset_idstringRequired

Request

This endpoint expects an object.
namestringOptional1-255 characters
New name.
descriptionstring or nullOptional
New description, or null to clear it.
publish_statusenumOptional
New publish status. Authors may submit their own drafts for review. Any other change requires an organization admin.
Allowed values:
querystringOptional

New SQL query: a single read-only SELECT statement. Reference parameters as :name.

default_parametersmap from strings to any or nullOptional
Default values for the query's parameters, keyed by name. They replace the saved defaults whole.

Response

OK
idstringformat: "uuid"
namestring
publish_statusenum
Whether an authored object is finished enough for others to rely on. In review marks a draft its author considers ready for an admin to publish.
Allowed values:
date_updateddatetime
descriptionstring or nullOptional
querystring or nullOptional
default_parametersmap from strings to any or nullOptional
userobject or nullOptional
access_levelenum or nullOptional
What a grant lets its grantee do. Manage includes edit and adds sharing, archiving and deleting.
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error