v1
latestSwagger 2.02026-07-1798126172.4 KBSession
Returns sessions history
Returns list of sessions history filtered by given query
get/sessions
Query parameters
page_sizeinteger
Number of items per page.
pageinteger
Page to filter the items by.
date_fromstring date
Filter the sessions from this date. Formatted in RFC3339 e.g. 2020-07-01.
date_tostring date
Filter the sessions until this date. Formatted in RFC3339 e.g. 2020-07-30.
directionstring
Direction to filter the sessions by. Possible values are "Provided", "Consumed".
consumer_idstring
Consumer identity to filter the sessions by.
hermes_idstring
Hermes ID to filter the sessions by.
provider_idstring
Provider identity to filter the sessions by.
service_typestring
Service type to filter the sessions by.
statusstring
Status to filter the sessions by. Possible values are "New", "Completed".
Response
List of sessions
Example response
{
"items": [
{
"bytes_received": 1024,
"bytes_sent": 1024,
"consumer_country": "NL",
"consumer_id": "0x0000000000000000000000000000000000000001",
"created_at": "2019-06-06T11:04:43.910035Z",
"direction": "Consumed",
"duration": 120,
"hermes_id": "0x0000000000000000000000000000000000000001",
"id": "4cfb0324-daf6-4ad8-448b-e61fe0a1f918",
"ip_type": "residential",
"provider_country": "US",
"provider_id": "0x0000000000000000000000000000000000000001",
"service_type": "openvpn",
"status": "Completed",
"tokens": "500000"
}
]
}