Skip to main content

List Browser Sessions

GET /v1/browser/sessions/

List active browser sessions for the user

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

NameInTypeRequiredDescriptionConstraints
X-API-Keyheaderstring | nullNonullable

Responses

200

Successful Response

application/json

Resolved schema:

{
"properties": {
"sessions": {
"items": {
"properties": {
"session_id": {
"type": "string",
"title": "Session Id"
},
"status": {
"type": "string",
"title": "Status"
},
"viewport_width": {
"type": "integer",
"title": "Viewport Width"
},
"viewport_height": {
"type": "integer",
"title": "Viewport Height"
},
"user_agent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "User Agent"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"last_activity": {
"type": "string",
"format": "date-time",
"title": "Last Activity"
},
"expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expires At"
}
},
"type": "object",
"required": [
"session_id",
"status",
"viewport_width",
"viewport_height",
"user_agent",
"created_at",
"last_activity",
"expires_at"
],
"title": "BrowserSessionResponse",
"description": "Response schema for browser session information"
},
"type": "array",
"title": "Sessions"
},
"total_count": {
"type": "integer",
"title": "Total Count"
}
},
"type": "object",
"required": [
"sessions",
"total_count"
],
"title": "BrowserSessionListResponse",
"description": "Response schema for listing browser sessions"
}

Field details:

FieldTypeRequiredDescriptionConstraints
sessionsarray<object>Yes
sessions[]objectYesResponse schema for browser session information
sessions[].session_idstringYes
sessions[].statusstringYes
sessions[].viewport_widthintegerYes
sessions[].viewport_heightintegerYes
sessions[].user_agentstring | nullYesnullable
sessions[].created_atstringYesformat=date-time
sessions[].last_activitystringYesformat=date-time
sessions[].expires_atstring | nullYesformat=date-time, nullable
total_countintegerYes

422

Validation Error

application/json

Resolved schema:

{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}

Field details:

FieldTypeRequiredDescriptionConstraints
detailarray<object>No
detail[]objectNo
detail[].locarray<string | integer>No
detail[].loc[]string | integerNo
detail[].msgstringNo
detail[].typestringNo