capabilities.work

Share a Dashboard as a Snapshot

A 3-step recipe with Grafana. We can help you get access.

Recipe · 3 steps

Share a Dashboard as a Snapshot

with Grafana · Analytics & BI Management

Publish a point-in-time snapshot of an existing dashboard.

  1. Read the dashboard model that will be frozen into the snapshot. The snapshot embeds this model, so what is read here is exactly what recipients will see.
  2. Publish the snapshot. Grafana returns the shareable URL, plus a delete key and delete URL that are the only means of revoking it later — store them with the snapshot record.
  3. Fetch the snapshot by its key to confirm it resolves and to see the frozen dashboard exactly as a recipient following the share URL would.
What you'll need to have ready
  • dashboardUid: UID of the dashboard to snapshot.
  • snapshotName: Name of the snapshot (e.g. "Checkout latency - incident 2291").
  • expires: Snapshot lifetime in seconds. Set one; an unexpiring snapshot of production data is a leak with no end date.
  • external: Publish to the configured external snapshot server instead of storing locally. Leave false unless you intend the data to leave your instance.
For your developer

Arazzo workflow grafana:share-dashboard-snapshot, 3 operations: getDashboardByUid → createDashboardSnapshot → getDashboardSnapshot. Specs on APIs.io.