Get a snapshot

GET

https://api.x.flatfile.com/v1/snapshots/:snapshotId

GET

/v1/snapshots/:snapshotId

1 from flatfile import Flatfile
2 
3 client = Flatfile(
4     token="YOUR_TOKEN",
5 )
6 client.snapshots.get_snapshot(
7     snapshot_id="us_ss_YOUR_ID",
8     include_summary=True,
9 )

Try it

1 {
2   "data": {
3     "id": "us_ss_YOUR_ID",
4     "sheetId": "us_sh_YOUR_ID",
5     "createdAt": "2023-01-01T00:00:00Z",
6     "createdBy": "us_usr_YOUR_ID",
7     "label": "My snapshot",
8     "summary": {
9       "createdSince": {
10         "total": 0
11       },
12       "updatedSince": {
13         "total": 5,
14         "byField": {
15           "lastName": 5
16         }
17       },
18       "deletedSince": {
19         "total": 5,
20         "byField": {
21           "firstName": 1
22         }
23       },
24       "schemaDiff": {
25         "firstName": "added",
26         "lastName": "removed",
27         "email": "unchanged"
28       },
29       "config": {
30         "name": "Contacts",
31         "fields": [
32           {
33             "type": "string",
34             "key": "firstName",
35             "label": "First Name"
36           },
37           {
38             "type": "string",
39             "key": "lastName",
40             "label": "Last Name"
41           },
42           {
43             "type": "string",
44             "key": "email",
45             "label": "Email"
46           }
47         ],
48         "slug": "contacts",
49         "mappingConfidenceThreshold": 0.5
50       }
51     }
52   }
53 }

Gets a snapshot of a sheet

Path parameters

snapshotIdstringRequired

ID of snapshot

Query parameters

includeSummarybooleanRequired

Whether to include a summary in the snapshot response

Response

This endpoint returns an object.

dataobject

Get a snapshot

Path parameters

Headers

Query parameters

Response

Errors