A snapshot is an array of data records. Datasets can have multiple snapshots, where each snapshot typically represents the dataset at a different point in time. The most recent snapshot is known as the “current snapshot.”

Delta updates

To update the data within a dataset, you have two options:

  • Add a new snapshot that represents the full set of data records. This is the default behavior when adding a snapshot to a dataset.
  • Add a new snapshot with data records that are appended to a copy of a previous snapshot (the “parent snapshot”). This creates a new snapshot within the dataset and is referred to as a “delta update.”

Snapshot attributes

NameTypeDescription 
created_at string <date-time> Date-time stamp indicating when the snapshot was created. READ
ONLY
dataset object The parent dataset. READ
ONLY
fields array An ordered array of fields (also known as 'columns' or 'attributes') representing the snapshot’s data schema1. REQUIRED
highlights array For snapshots returned based on a search string, this provides positional information indicating where instances of the specified query string occur. READ
ONLY
id string <uuid> The snapshot’s unique identifier. This never changes.
ingest_status object See below2. READ
ONLY
parent_snapshot object The id attribute of the snapshot from which this snapshot was formed (see 'Delta updates' above).
row_count integer <int64> The number of records (rows) within the snapshot’s data. READ
ONLY
size integer <int64> Total disk space used by the snapshot (in bytes). READ
ONLY
stats object <stats> Statistical information about the snapshot. READ
ONLY
table_rows object The data contained within the snapshot. READ
ONLY

1 See SnapshotField attributes below.

2 The ingest_status attribute is for internal use only.

SnapshotField attributes

NameTypeDescription 
data_type string Values: datetime decimal boolean string integer
The field type.
REQUIRED
description string A description of the field.
display_name string The field name displayed as the column label in the Assembly client interface.
name string The internal field name (characters a-zA-Z0-9_ only). REQUIRED
visible_by_default boolean When true (the default value), the field is displayed within the Assembly client interface.
{
  "created_at": "2017-05-25T15:35:11.726Z",
  "dataset": {
    "ancestors": [
      {
        "ancestors": [
          {}
        ],
        "created_at": "2017-05-25T15:35:11.726Z",
        "description": "string",
        "description_short": "string",
        "display_name": "string",
        "editable": true,
        "highlights": [
          {
            "offsets": [
              [
                0
              ]
            ],
            "path": [
              "string"
            ]
          }
        ],
        "id": "string",
        "modified_at": "2017-05-25T15:35:11.726Z",
        "parent_collection": {},
        "published": true,
        "score": 0
      }
    ],
    "citation": "string",
    "created_at": "2017-05-25T15:35:11.726Z",
    "current_snapshot": {},
    "data_updated_at": "2017-05-25T15:35:11.726Z",
    "description": "string",
    "description_short": "string",
    "display_name": "string",
    "editable": true,
    "highlights": [
      {
        "offsets": [
          [
            0
          ]
        ],
        "path": [
          "string"
        ]
      }
    ],
    "id": "string",
    "modified_at": "2017-05-25T15:35:11.727Z",
    "parent_collection": {
      "ancestors": [
        {}
      ],
      "created_at": "2017-05-25T15:35:11.727Z",
      "description": "string",
      "description_short": "string",
      "display_name": "string",
      "editable": true,
      "highlights": [
        {
          "offsets": [
            [
              0
            ]
          ],
          "path": [
            "string"
          ]
        }
      ],
      "id": "string",
      "modified_at": "2017-05-25T15:35:11.727Z",
      "parent_collection": {},
      "published": true,
      "score": 0
    },
    "published": true,
    "schema_updated_at": "2017-05-25T15:35:11.727Z",
    "score": 0
  },
  "fields": [
    {
      "data_type": "integer",
      "description": "string",
      "display_name": "string",
      "name": "string",
      "visible_by_default": true
    }
  ],
  "highlights": [
    {
      "offsets": [
        [
          0
        ]
      ],
      "path": [
        "string"
      ]
    }
  ],
  "id": "string",
  "parent_snapshot": {},
  "row_count": 0,
  "size": 0,
  "stats": {},
  "table_rows": {
    "count": 0,
    "fields": [
      "string"
    ],
    "rows": [
      [
        "string"
      ]
    ]
  }
}