Automating Snapshots


Create a Snapshot

Required API Permission: Create Snapshots

You can create snapshosts with the CLI, Node.js API, HTTP Site API or GraphQL API.

Example Response
ParameterRequiredDescription
siteYesSite slug, found in site settings
refNoSets a reference to the snapshot

List Snapshots

Required API Permission: Read Sites

You can list Snapshots with the CLI, Node.js API, GraphQL API or by using the HTTP Site API.

Example Response
ParameterRequiredDescription
siteYesSite slug, found in site settings
countNoThe number of records to return, maximum: 500
cursorNoThe cursor to fetch records after

Snapshot Status

The status of the Snapshot will be one of:

  • scheduled: the Snapshot has been scheduled, no tests are running.
  • running: at least one test is running.
  • verifying: at least one test is being verified.
  • errored: all tests completed, and at least one test errored or failed.
  • completed: all tests completed successfully.

Download Snapshot artifacts

Required API Permission: Read Page Tests

For each Snapshot, Calibre stores the following information:

  • lighthouse.json
  • screenshots
  • video render
  • HAR file
  • all other metrics and data available through the interface

You can download Snapshot artifacts with the CLI. Files will be saved to snapshot-artifacts directory.

Delete a Snapshot

Required API Permission: Delete Snapshots

You can delete a Snapshot with the CLI, Node.js API or GraphQL API.

Example Response
ParameterRequiredDescription
siteYesSite slug, found in site settings
idYesThe id of the snapshot

Retrieve a Snapshot

You can retrieve a Snapshot with the HTTP Site API.

Example Response
ParameterRequiredDescription
siteYesSite slug, found in site settings
idYesThe id of the snapshot

Related Articles