Snapshot Collection

Output representation of the retrieved snapshot collection.

JSON Example 

1{
2  "errors": [],
3  "snapshots": [
4    {
5      "activationDate": "2024-11-06T06:58:02.000Z",
6      "activationStatus": "ACTIVE",
7      "activationType": "IMMEDIATE",
8      "id": "1Avxx0000004C92CAE",
9      "snapshotIndexes": [
10        {
11          "createdDate": "2024-11-06T06:56:49.000Z",
12          "id": "1D6xx0000004C92CAE",
13          "indexBuildType": "FULL",
14          "indexInfos": [
15            {
16              "buildType": "FULL",
17              "id": "0axxx00000000T3AAI",
18              "isIncrementable": true,
19              "usageType": "LIVE"
20            }
21          ],
22          "indexLogs": [
23            {
24              "catalogSnapshotTime": "2024-11-06T16:14:30.000Z",
25              "completionTime": "2024-11-06T16:16:02.000Z",
26              "createdById": "005xx000001X7x7AAC",
27              "indexBuildStatus": "COMPLETED",
28              "indexBuildType": "FULL",
29              "indexId": "0axxx00000000T3AAI",
30              "numberOfChanges": 7
31            },
32            {
33              "catalogSnapshotTime": "2024-11-06T15:03:32.000Z",
34              "completionTime": "2024-11-06T15:05:02.000Z",
35              "createdById": "005xx000001X7x7AAC",
36              "indexBuildStatus": "COMPLETED_WITH_ERRORS",
37              "indexBuildType": "INCREMENTAL",
38              "indexId": "0axxx00000000RRAAY",
39              "message": "Warning: Product errors found.",
40              "numberOfChanges": 3
41            },
42            {
43              "catalogSnapshotTime": "2024-11-06T12:35:34.000Z",
44              "completionTime": "2024-11-06T12:35:34.000Z",
45              "createdById": "005xx000001X7x7AAC",
46              "indexBuildStatus": "COMPLETED",
47              "indexBuildType": "INCREMENTAL",
48              "indexId": "0axxx00000000RRAAY",
49              "message": "There are no changes for the partial update.",
50              "numberOfChanges": 0
51            },
52            {
53              "catalogSnapshotTime": "2024-11-06T12:07:32.000Z",
54              "completionTime": "2024-11-06T12:09:02.000Z",
55              "createdById": "005xx000001X7x7AAC",
56              "indexBuildStatus": "COMPLETED_WITH_ERRORS",
57              "indexBuildType": "FULL",
58              "message": "Warning: Product errors found.",
59              "numberOfChanges": 1
60            }
61          ],
62          "indexType": "PRODUCT",
63          "lastBuildStatus": "IN_PROGRESS",
64          "venueId": "1D6xx0000004C92CAE"
65        }
66      ]
67    }
68  ],
69  "statusCode": "200"
70}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
errorsError Output[]List of errors, if any.Small, 62.062.0
snapshotsSnapshot[]List of active snapshots.Small, 62.062.0
statusCodeStringCode indicating the status of the request.Small, 62.062.0