Skip to main content

Retrieve a snapshot by ID

GET 
/v1/snapshotter/:snapshotId

Returns the details of a snapshot, such as status and the snapshot image URL. Note that snapshots are stored for 30 days and automatically deleted afterwards. Please ensure to change the region in the URL to match your account's region.

Request​

Path Parameters

    snapshotId int32required

    ID of the snapshot

    Example: 3094

Responses​

successful operation

Schema
    snapshotId int32

    ID of the snapshot

    accountId int32

    ID of the account

    snapshotType string

    Possible values: [DASHBOARD, VISUALIZATION]

    The object type

    status string

    Possible values: [SUCCESS, FAILED, IN_PROGRESS]

    Status of the snapshot capture operation

    snapshotSavedObjectName string

    Name of the object captured in the snapshot

    imageUrl string

    Web address where the snapshot image is stored

    appLinkUrl string

    A link to the snapshot in the Logz.io app

    message string

    Message to send to snapshot recipients

    timeFrameFrom int64

    Starting timedate of the visualization, as a Unix epoch integer.

    timeFrameTo int64

    Ending timedate of the visualization, as a Unix epoch integer.

    snapshotTimeZone string

    Time zone to use in timeFrameFrom and timeFrameTo

Loading...