apify-docs/apify-api/openapi/components/schemas/datasets/Dataset.yaml at 3bf82b6ed27daba9fba93192c4230534552b5010 · apify/apify-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
title: Dataset
required:
  - id
  - userId
  - createdAt
  - modifiedAt
  - accessedAt
  - itemCount
  - cleanItemCount
  - consoleUrl
type: object
properties:
  id:
    type: string
    examples: [WkzbQMuFYuamGv3YF]
  name:
    type: string
    examples: [d7b9MDYsbtX5L7XAj]
  userId:
    type: string
    examples: [wRsJZtadYvn4mBZmm]
  createdAt:
    type: string
    format: date-time
    examples: ["2019-12-12T07:34:14.202Z"]
  modifiedAt:
    type: string
    format: date-time
    examples: ["2019-12-13T08:36:13.202Z"]
  accessedAt:
    type: string
    format: date-time
    examples: ["2019-12-14T08:36:13.202Z"]
  itemCount:
    type: integer
    minimum: 0
    examples: [7]
  cleanItemCount:
    type: integer
    minimum: 0
    examples: [5]
  actId:
    type: [string, "null"]
  actRunId:
    type: [string, "null"]
  fields:
    type: [array, "null"]
    items:
      type: string
    description: ""
  schema:
    type: [object, "null"]
    description: Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)
    example:
      actorSpecification: 1
      title: My dataset
      views:
        overview:
          title: Overview
          transformation:
            fields:
              - linkUrl
          display:
            component: table
            properties:
              linkUrl:
                label: Link URL
                format: link
  consoleUrl:
    type: string
    format: uri
    examples: ["https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC"]
  itemsPublicUrl:
    type: string
    format: uri
    description: A public link to access the dataset items directly.
    examples: ["https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123"]
  urlSigningSecretKey:
    type: [string, "null"]
    description: A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset.
  generalAccess:
    $ref: ../common/GeneralAccess.yaml
  stats:
    $ref: ./DatasetStats.yaml