Skip to content

Snapshot🔗

A dashboard snapshot shares an interactive dashboard publicly.

It is a read-only version of a dashboard, and is not editable.

It is possible to create a snapshot of a snapshot.

Grafana strips away all sensitive information from the dashboard.

Sensitive information stripped: queries (metric, template,annotation) and panel links.

Definition🔗

class Snapshot implements \JsonSerializable
{
    /**
     * Time when the snapshot was created
     */
    public string $created;

    /**
     * Time when the snapshot expires, default is never to expire
     */
    public string $expires;

    /**
     * Is the snapshot saved in an external grafana instance
     */
    public bool $external;

    /**
     * external url, if snapshot was shared in external grafana instance
     */
    public string $externalUrl;

    /**
     * original url, url of the dashboard that was snapshotted
     */
    public string $originalUrl;

    /**
     * Unique identifier of the snapshot
     */
    public int $id;

    /**
     * Optional, defined the unique key of the snapshot, required if external is true
     */
    public string $key;

    /**
     * Optional, name of the snapshot
     */
    public string $name;

    /**
     * org id of the snapshot
     */
    public int $orgId;

    /**
     * last time when the snapshot was updated
     */
    public string $updated;

    /**
     * url of the snapshot, if snapshot was shared internally
     */
    public ?string $url;

    /**
     * user id of the snapshot creator
     */
    public int $userId;

    public ?\Grafana\Foundation\Dashboard\Dashboard $dashboard;

}

Methods🔗

fromArray🔗

Builds this object from an array.

This function is meant to be used with the return value of json_decode($json, true).

static fromArray(array $inputData)

jsonSerialize🔗

Returns the data representing this object, preparing it for JSON serialization with json_encode().

jsonSerialize()

See also🔗