Skip to main content
Version: Next

DatasetResource

Represents a dataset storage on the Apify platform.

Datasets store structured data as a sequence of items (records). Each item is a JSON object. Datasets are useful for storing results from web scraping, crawling, or data processing tasks.

Hierarchy

  • Omit<Schemas[DatasetResource], keyof DatasetResourceRePointed | keyof DatasetResourceSpecNarrowings>
  • DatasetResourceRePointed
  • DatasetResourceSpecNarrowings
  • DatasetResourceSpecGaps
    • DatasetResource

Index

Properties

Properties

inheritedaccessedAt

accessedAt: Date

Format: date-time

2019-12-14T08:36:13.202Z

optionalinheritedactId

actId?: null | string

optionalinheritedactRunId

actRunId?: null | string

inheritedcleanItemCount

cleanItemCount: number
5

optionalinheritedconsoleUrl

consoleUrl?: string

inheritedcreatedAt

createdAt: Date

Format: date-time

2019-12-12T07:34:14.202Z

optionalinheritedfields

fields?: null | string[]

optionalinheritedgeneralAccess

generalAccess?: null | STORAGE_GENERAL_ACCESS

inheritedid

id: string
WkzbQMuFYuamGv3YF

inheriteditemCount

itemCount: number
7

optionalinheriteditemsPublicUrl

itemsPublicUrl?: string

Format: uri

https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123

A public link to access the dataset items directly.

inheritedmodifiedAt

modifiedAt: Date

Format: date-time

2019-12-13T08:36:13.202Z

optionalinheritedname

name?: null | string
d7b9MDYsbtX5L7XAj

optionalinheritedschema

schema?: null | Record<string, unknown>
{
             *       "actorSpecification": 1,
             *       "title": "My dataset",
             *       "views": {
             *         "overview": {
             *           "title": "Overview",
             *           "transformation": {
             *             "fields": [
             *               "linkUrl"
             *             ]
             *           },
             *           "display": {
             *             "component": "table",
             *             "properties": {
             *               "linkUrl": {
             *                 "label": "Link URL",
             *                 "format": "link"
             *               }
             *             }
             *           }
             *         }
             *       }
             *     }

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

optionalinheritedstats

stats?: DatasetStats

optionalinheritedtitle

title?: string

optionalinheritedurlSigningSecretKey

urlSigningSecretKey?: null | string

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

inheriteduserId

userId: string
wRsJZtadYvn4mBZmm

optionalinheritedusername

username?: string
Page Options