Retrieve a snapshot by ID
GET/v1/snapshotter/:snapshotId
Returns the details of a snapshot, such as status and the snapshot image URL
Request
Path Parameters
snapshotId int32required
ID of the snapshot
Example: 3094
Responses
- 200
successful operation
- application/json
- Schema
- Example (from schema)
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
{
"snapshotId": 3094,
"accountId": 5555,
"snapshotType": "VISUALIZATION",
"status": "SUCCESS",
"snapshotSavedObjectName": "Mysql response times percentiles",
"imageUrl": "https://snapshotter-logzio-prod.s3.amazonaws.com/1234/567890/snapshots/8843_3094_dC6pBjbrWc1lfN7Gob82oJuSUxTGbm8D6hDE1TcR1pVzIVO0TsB3tuZEZs1YpOGh.png",
"appLinkUrl": "https://app.logz.io/#/dashboard/kibana?kibanaRoute=%2Fvisualize%2Fedit%a4d365e001-5bc9-4851-1933-a70b45a67e9d%3F_g%3D%2528time%253A%2528from%253A%25272018-06-02T15",
"message": "Hey, let me know if you need me to do anything about this.",
"timeFrameFrom": 389836800,
"timeFrameTo": 414720000,
"snapshotTimeZone": "UTC"
}
Loading...