List datasets
Lists the datasets of a project, ordered by name by default. The project_id query parameter is required.
Authorization
personalAccessToken Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.
In: header
Query Parameters
Project UUID to list datasets for.
Page number (1-based).
Number of items per page. Values below the minimum or above the maximum are clamped to the nearest bound.
Comma-separated sort fields. Prefix a field with - for descending order, e.g. sort=-started_at.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/datasets?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"latest_version_id": "8562ca50-d99e-4ec5-9529-9c17b0fd462e",
"latest_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
"version": 0,
"status": "draft",
"schema": {
"type": "any",
"properties": {
"property1": {
"type": "any",
"properties": {},
"required": true
},
"property2": {
"type": "any",
"properties": {},
"required": true
}
},
"required": true
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
},
"updated_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
},
"updated_by": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
}
}
],
"pagination": {
"page": 0,
"page_size": 0,
"page_count": 0,
"total_count": 0
}
}{
"error": {
"code": "bad_request",
"message": "Bad Request",
"details": {
"input": "cannot be blank"
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"error": {
"code": "not_found",
"message": "Not Found"
}
}Get a metric version
Returns a specific version of a metric, including its full `config`. The `version_id` path parameter accepts a version UUID or the literal `latest`.
Create a dataset
Creates an empty dataset in a project. A dataset is a named container for versioned collections of rows; add rows by creating a version and adding items to it.