Get list of datasets

GET 
/v2/datasets

Lists all of a user's datasets.

The response is a JSON array of objects, where each object contains basic information about one dataset.

By default, the objects are sorted by the createdAt field in ascending order, therefore you can use pagination to incrementally fetch all datasets while new ones are still being created. To sort them in descending order, use desc=1 parameter. The endpoint supports pagination using limit and offset parameters and it will not return more than 1000 array elements.

Request

Query Parameters

offset double
Number of items that should be skipped at the start. The default value is 0.

Example: 0
limit double
Maximum number of items to return. The default value as well as the maximum is 1000.

Example: 1000
desc boolean
If true or 1 then the results are returned in descending order. By default, they are sorted in ascending order.

Example: true
unnamed boolean
If true or 1 then all the storages are returned. By default, only named storages are returned.

Example: true
ownership StorageOwnership
Possible values: [ownedByMe, sharedWithMe]
Filter by ownership. If this parameter is omitted, all accessible datasets are returned.
• ownedByMe: Return only datasets owned by the user.
• sharedWithMe: Return only datasets shared with the user by other users.

Example: ownedByMe

Status 200

Response Headers

{
  "data": {
    "total": 1,
    "offset": 0,
    "limit": 1000,
    "desc": false,
    "count": 1,
    "items": [
      {
        "id": "WkzbQMuFYuamGv3YF",
        "name": "d7b9MDYsbtX5L7XAj",
        "userId": "tbXmWu7GCxnyYtSiL",
        "createdAt": "2019-12-12T07:34:14.202Z",
        "modifiedAt": "2019-12-13T08:36:13.202Z",
        "accessedAt": "2019-12-14T08:36:13.202Z",
        "itemCount": 7,
        "cleanItemCount": 5,
        "actId": "zdc3Pyhyz3m8vjDeM",
        "actRunId": "HG7ML7M8z78YcAPEB"
      }
    ]
  }
}

Schema

• data object required

  Common pagination fields for list responses.

  • total integer required

    The total number of items available across all pages.

    Possible values: >= 0

    
    Example: 1
  • offset integer required

    The starting position for this page of results.

    Possible values: >= 0

    
    Example: 0
  • limit integer required

    The maximum number of items returned per page.

    Possible values: >= 1

    
    Example: 1000
  • desc boolean required

    Whether the results are sorted in descending order.

    
    Example: false
  • count integer required

    The number of items returned in this response.

    Possible values: >= 0

    
    Example: 1
  • items object[] required

    • id string required
      Example: WkzbQMuFYuamGv3YF
    • name string required
      Example: d7b9MDYsbtX5L7XAj
    • userId string required
      Example: tbXmWu7GCxnyYtSiL
    • createdAt string<date-time> required
      Example: 2019-12-12T07:34:14.202Z
    • modifiedAt string<date-time> required
      Example: 2019-12-13T08:36:13.202Z
    • accessedAt string<date-time> required
      Example: 2019-12-14T08:36:13.202Z
    • itemCount integer required
      Example: 7
    • cleanItemCount integer required
      Example: 5
    • actId string | null nullable
      Example: zdc3Pyhyz3m8vjDeM
    • actRunId string | null nullable
      Example: HG7ML7M8z78YcAPEB

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)