API Documentation | Snapshot
The Snapshot API endpoint allows you to retrieve PNG images of shared resources such as shared graphs, shared dashboards, and shared worksheets. Use this API with a GET call including query parameters that describe the shared resource. The response will include a base64-encoded PNG image of the shared page as it appeared at the time of the request.
Note: This is currently a beta API endpoint and is subject to change without notice.
Note: Currently, Dashboard widgets configured for streaming data will appear as blank widgets on shared Dashboard images.
Example
Fetching Data
To fetch a PNG image of a shared resource, perform an HTTP GET request to /snapshot including the following required query parameters:
- type
- The type of shared resource, one of 'dashboards', 'graphs', or 'worksheets' (plural)
- uuid
- The uuid of the shared resource
- key
- The access key of the shared resource
You can find the above elements for any shared resource by examining its URL. They are the last three path elements of the URL; e.g., for the following URL
https://share.circonus.com/shared/dashboards/36b5a748-5614-57f1-87e3-32ca709c9cza/JMbcvC
- type = dashboards
- uuid = 36b5a748-5614-57f1-87e3-32ca709c9cza
- key = JMbcvC
Circonus Keyboard Shortcuts
Jump Navigation
docs- Jump to the user documentation.
Application Shortcuts
?- Show this keyboard help screen.
<esc>- Close help screens and dialogs.
/- Focus on any available search field.
r- Refresh content on the page without reloading the entire page; currently works on graphs, worksheets, and dashboards.
Graph Grid Shortcuts
<shift>- On a worksheet, hold it down to invert the current legend hover
setting.
On “My Graphs” and the “Trending & Analytics Dash,” hold it down to show the legend when hovering over a graph.
Graph Shortcuts
<comma>- Hold down to show the date shifting toolbar for modifying the start date. Can be combined with <period>.
<period>- Hold down to show the date shifting toolbar for modifying the end date. Can be combined with <comma>.
<ctrl>+<alt>+<left>- Nudge the date range for the current graph(s) backward.
<ctrl>+<alt>+<right>- Nudge the date range for the current graph(s) forward.
h- Toggle the display of histogram sparklines (shown upon hovering over a graph when viewing or when on a dashboard).
s- Hold down to unlock graph hovering datapoint selection, allowing mouse hovering to select nearby datapoints.
Mousewheel & Touchpad Shortcuts
<shift>- Hold down while scrolling to zoom graphs' Y axes.
<alt>- Hold down while scrolling to zoom graphs' X axis.
<ctrl>+<alt>- Hold down while scrolling to shift graphs' X axis.
<comma>- Hold down while scrolling to shift graphs' X axis start dates. Can be combined with <period>.
<period>- Hold down while scrolling to shift graphs' X axis end dates. Can be combined with <comma>.