Get Snapshot List¶

GET /api/v1/snapshots/list

Overview¶

Retrieve the snapshot list for the current workspace

Query Request Parameters¶

Parameter Name	Type	Required	Description
type	string	No	Type filter Can be empty: False
search	string	No	Search snapshot name Can be empty: False
pageIndex	integer	No	Page number Can be empty: False Example: 1 $minValue: 1
pageSize	integer	No	Number of items per page Can be empty: False Example: 10 $minValue: 1 $maxValue: 100

Additional Parameter Explanation¶

Data Explanation

1. Snapshot Type Explanation

Key	Description
logging	Log Explorer
keyevent	Event Explorer
tracing	Trace Explorer
object	Infrastructure Explorer
dialing_task	Dial Testing Explorer
security	Security Check Explorer
rum	RUM PV Explorer
measurement	Metrics Explorer
scene_dashboard	Scene View
dashboard	User-defined View

Request Example¶

curl 'https://us1-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"
}