List¶
GET /api/v1/snapshots/list
Overview¶
Retrieve the snapshot list of the current workspace.
Query Request Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| type | string | Type filter Can be empty: False |
|
| search | string | Search snapshot name Can be empty: False |
|
| pageIndex | integer | Page number Can be empty: False Example: 1 $minValue: 1 |
|
| pageSize | integer | Number of items to return per page Can be empty: False Example: 10 $minValue: 1 $maxValue: 100 |
Additional Parameter Notes¶
Data Notes
1. Snapshot Type Description
| key | Description |
|---|---|
| logging | LOG Explorers |
| keyevent | Event Explorers |
| tracing | APM Explorers |
| object | Infrastructure Explorers |
| dialing_task | TESTING Explorers |
| security | Security Check Explorers |
| rum | RUM PV Explorers |
| measurement | Metrics Explorers |
| scene_dashboard | Scene Views |
| dashboard | User-defined Views |
Request Example¶
curl 'https://openapi.truewatch.com/api/v1/snapshots/list?pageIndex=1&pageSize=2' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
Response¶
{
"code": 200,
"content": [
{
"accountUUID": "acnt_xxxx32",
"content": {
"routeName": "Log",
"routeParams": {
"source": "others"
},
"routeQuery": {
"tags": "{\\\"source\\\":[\\\"python_ddtrace_log_ee\\\"]}",
"time": "1629713566000,1629714466999"
}
},
"createAt": 1629714466,
"creator": "acnt_xxxx32",
"deleteAt": -1,
"id": 435,
"name": "fa",
"status": 0,
"type": "logging",
"updateAt": 1629714466,
"updator": "acnt_xxxx32",
"uuid": "snap_xxxx32",
"workspaceUUID": "wksp_xxxx32"
}
],
"errorCode": "",
"message": "",
"pageInfo": {
"count": 1,
"pageIndex": 1,
"pageSize": 3,
"totalCount": 1
},
"success": true,
"traceId": "TRACE-EF64E702-8660-4D45-94B9-F058FCB00E17"
}