Get dataset

GET 
/v2/datasets/:datasetId

Returns dataset object for given dataset ID.

This does not return dataset items, only information about the storage itself. To retrieve dataset items, use the List dataset items endpoint.

note

Keep in mind that attributes itemCount and cleanItemCount are not propagated right away after data are pushed into a dataset.

There is a short period (up to 5 seconds) during which these counters may not match with exact counts in dataset items.

Request

Path Parameters

datasetId string required
Dataset ID or username~dataset-name.

Example: WkzbQMuFYuamGv3YF

Query Parameters

token string
API authentication token. It is required only when using the username~dataset-name format for datasetId.

Example: soSkq9ekdmfOslopH

Status 200

Response Headers

{
  "data": {
    "id": "WkzbQMuFYuamGv3YF",
    "name": "d7b9MDYsbtX5L7XAj",
    "userId": "wRsJZtadYvn4mBZmm",
    "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": null,
    "actRunId": null,
    "fields": [],
    "consoleUrl": "https://console.apify.com/storage/datasets/WkzbQMuFYuamGv3YF"
  }
}

Schema

• data object required

  • id string required
    Example: WkzbQMuFYuamGv3YF
  • name string
    Example: d7b9MDYsbtX5L7XAj
  • userId string required
    Example: wRsJZtadYvn4mBZmm
  • 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

    Possible values: >= 0

    
    Example: 7
  • cleanItemCount integer required

    Possible values: >= 0

    
    Example: 5
  • actId string | null nullable
  • actRunId string | null nullable
  • fields string[] nullable
  • schema object | null nullable

    Defines the schema of items in your dataset, the full specification can be found in Apify docs

    
    Example: {"actorSpecification":1,"title":"My dataset","views":{"overview":{"title":"Overview","transformation":{"fields":["linkUrl"]},"display":{"component":"table","properties":{"linkUrl":{"label":"Link URL","format":"link"}}}}}}
  • consoleUrl string<uri> required
    Example: https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC
  • itemsPublicUrl string<uri>

    A public link to access the dataset items directly.

    
    Example: https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123
  • urlSigningSecretKey string | null nullable

    A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset.

  • generalAccess GeneralAccessEnum (string)

    Defines the general access level for the resource.

    Possible values: [ANYONE_WITH_ID_CAN_READ, ANYONE_WITH_NAME_CAN_READ, FOLLOW_USER_SETTING, RESTRICTED]

    
    Example: RESTRICTED
  • stats object

    • readCount integer required
      Example: 22
    • writeCount integer required
      Example: 3
    • storageBytes integer required
      Example: 783

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)