APapify
Storage/Datasets

Get list of datasets

Changed on

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.

get/v2/datasets

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Query parameters

offsetnumber double

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

limitnumber double
Example:1000

Maximum number of items to return. The default value as well as the maximum is 1000.

descboolean
Example:true

If true or 1 then the objects are sorted by the createdAt field in descending order. By default, they are sorted in ascending order.

unnamedboolean
Example:true

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

ownership'ownedByMe' | 'sharedWithMe'
Example:ownedByMe

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.

Response

Example response

{
  "data": {
    "total": 1,
    "limit": 1000,
    "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",
        "title": "My Dataset",
        "username": "janedoe",
        "generalAccess": "RESTRICTED",
        "stats": {
          "readCount": 22,
          "writeCount": 3,
          "storageBytes": 783
        }
      }
    ]
  }
}

Changes

  • ec76185eb934Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • e52dd2239ceeRevision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became optional for the status