Sessions
Get Session
Get a session by id. This endpoint returns a conditional response
- When the query string
extension
is present it will return a payload containing a link to download the session
{
"download_url": "http://127.0.0.1:8009/api/sessions/<id>/download?token=<token>&extension=csv&newline=1&event-time=0&events=o,e",
"expire_at": "2024-07-25T15:56:35.317601Z",
}
- Fetching the endpoint without any query string returns the payload documented for this endpoint
- The attribute
event_stream
will be rendered differently if the request contains the query stringevent_stream=utf8
{
(...)
"event_stream": ["hello world"]
(...)
}
The attribute metrics
contains the following structure:
{
"data_masking": {
"err_count": 0,
"info_types": {
"EMAIL_ADDRESS": 1
},
"total_redact_count": 1,
"transformed_bytes": 31
},
"event_size": 356
}
GET
Path Parameters
The id of the resource
Query Parameters
Construct the file content adding the event time as prefix when parsing each event
Available options:
0
, 1
This option will parse the session output (o) and error (e) events as an utf-8 content in the session payload
Available options:
utf8
, base64
Choose the type of events to include
i
- Input (stdin)o
- Output (stdout)e
- Error (stderr)
Expand the given attributes
Available options:
event_stream
The file extension to donwload the session as a file content.
csv
- it will parse the content to format in csv formatjson
- it will parse the content as a json stream.<any-format>
- No special parsing is applied
Construct the file content adding a break line when parsing each event
Available options:
0
, 1
Response
200
application/json
OK
The response is of type object
.