If you haven't installed Snapshots and taken your first snapshot, start with Get started — those basics are covered there: installing the apps, taking your first snapshot from Jira or from Confluence, and the core concepts behind how snapshots work.
This section covers everything else you can do with the Snapshots macro, organized around what you're trying to accomplish.
Configuring a snapshot
How to shape what a snapshot looks like and what data it captures.
-
Configuring multi-level snapshots — go beyond a flat list by adding levels for parent/child issues, blockers, sub-tasks, and other Jira relationships.
-
Field options: sort and don't-wrap — per-field controls for default sort order and text wrapping.
-
Using placeholders — fill empty cells (per field) and missing levels with explicit text. Important for regulated and audit contexts.
-
Grouping rows by a field — break the level-1 view into sections by a field's values.
-
Display options on the Layout tab — full grid, headers, borders, issue type icons, JQL display, auto-detect issue keys, grouping defaults.
-
Snapshots scrolling for large pages — performance-friendly rendering for snapshots with hundreds or thousands of rows.
-
Adding Xray data to snapshots — add Xray-specific fields to a tests level, and use the new test run level type.
Reading and exploring a snapshot
How to work with a snapshot on the rendered page.
-
Sorting, filtering, and grouping on the page — view-time manipulations that don't change the macro configuration. Useful for personal exploration; not visible to other page viewers.
-
Using stickers — tag specific snapshot versions so you can find them later (for example, "Steering review – Q1 2026").
-
Taking all snapshots on a page — refresh every snapshot on the page in one click.
-
Comparing snapshots over time — see what changed between two snapshots of the same page.
-
Exporting snapshots to Excel — direct Excel download, copy-to-clipboard, and embedded-Excel-in-PDF for very large snapshots.
Automating snapshots
How to refresh snapshots without anyone clicking Take snapshot.
-
Triggering snapshots automatically — enable the per-macro REST endpoint and call it from any HTTP-capable tool. The starting point for every automation flow.
-
Using Jira Automation to Trigger a Snapshot Automatically — recipe using a Jira Automation rule.
-
Triggering a Snapshot from a GitHub Action — recipe using GitHub Actions and Python.
-
Using Automation to Create Pages With Snapshots — combine the global API key with Confluence templates to auto-generate pages.
For administrators who control the site-wide automation toggle and the global API key, see Administering Snapshots automation in the Admin guide.
Reference for the macros
-
The Snapshots macro — the main macro this manual is built around. Covered throughout this section.
-
Snapshots Test Report macro — available when the Traceability Extension is installed. Use it for compliance-style detailed test reports.
Personal preferences
-
Snapshots User Settings — per-user setting for whether Snapshots automatically takes a fresh snapshot when you change a macro's configuration.
Concepts that underpin everything here
If anything here surprises you, the answer is usually in How snapshots work — the static-data model, page-versioning behavior, and where snapshot data is stored. Worth reading once.