API Base URL
Security: Bearer AuthProvide your bearer token in the Authorization header when making requests to protected resources.Example:
Authorization: Bearer 123The DataSet Object
The DataSet API allows you to create, replace, append to, export, and manage DataSets, as well as manage data permissions for DataSets within Domo. Most of its calls return a DataSet object.
Best Practice
The DataSet API should be used to create and update small DataSets that occasionally need their data updated. For creating and updating massive, constantly changing, or rapidly growing DataSets, the Stream API is recommended.Permissions
To update or write to a DataSet via API, you must have the Manage DataSet grant enabled.Attributes
| Property Name | Type | Description |
|---|---|---|
| id | String | ID of the DataSet |
| name | String | Name of the DataSet |
| description | String | Description of DataSet |
| owner.id | String | ID of the owner |
| owner.name | String | Name of the owner |
| columns | Number | The number of columns currently in the DataSet |
| createdAt | String | An ISO-8601 representation of the creation date of the DataSet |
| updatedAt | String | AN ISO-8601 representation of the time the DataSet was last updated |
| dataCurrentAt | String | An ISO-8601 representation of the time the DataSet was current |
| schema | Object | The current schema associated with this DataSet |
| schema.columns | Array | Array of columns in the DataSet |
| schema.columns[].name | String | Column name in the DataSet schema |
| schema.columns[].type | String | Column type in the DataSet schema. Valid types are STRING, DECIMAL, LONG, DOUBLE, DATE, DATETIME. |
| pdpEnabled | Boolean | Indicates if PDP [Personalized Data Permission] policy filtering on data is active on this DataSet |
| policies | Array | List of policies attached to DataSet |
| policies[].filters[].column | String | Name of the column to filter on |
| policies[].filters[].not | Boolean | Determines if NOT is applied to the filter operation |
| policies[].filters[].operator | String | Matching operator (EQUALS) |
| policies[].filters[].values[] | String | Values to filter on |
| policies[].groups | Array | List of group IDs the policy applies to |
| policies[].id | Number | ID of the Policy |
| policies[].name | String | Name of the Policy |
| policies[].type | String | Type of policy (user or system) |
| policies[].users | Array | List of user IDs the policy applies to |
| rows | Number | The number of rows currently in the DataSet |