Dataset Management API (DSMAPI)

Heads Up! The ability to modify a dataset requires special permissions.

Introduction

The Dataset Management API (DSMAPI) is what powers the Dataset Management Experience interface for creating new and editing existing datasets. When your data requires transformation before publishing, you can utilize this API’s native data transformation functions for the task. If you need to stage changes to a published dataset, whether related to its metadata, column schema, or row data, you can utilize a revision, which is a core feature of updating datasets via this API (in fact, you cannot update a dataset via this API without routing through a revision)—simply leave the revision unpublished with the changes staged, and then publish it as soon as it’s time to go live.

Please note that all operations that modify datasets must be authenticated as a user who has access to modify that dataset and may optionally include an application token.

When to use this API

If you have created a dataset using the Dataset Management Experience and created at least one data transform, this is the ideal API for updating your data going forward. This API will allow you to continue to use the same input fields from your original data and will run the same transforms you initially set up, for every update.

For example, if your source file contains a column with the street number and a column for the street name, and you set up a transform to combine that into a single column in your Socrata dataset, you can use this API to continue importing files with those two columns (street number and street name) and running the transform to combine into a single column that uploads to your Socrata dataset.

  • Check out socrata-py, the official Python SDK for the Dataset Management API
  • Find more detailed documentation for this API on its Apiary page