Skip to main content
GET
/
browser
/
sessions
Get browser sessions
curl --request GET \
  --url https://app.nextbrowser.com/api/v1/browser/sessions \
  --header 'Authorization: <api-key>'
{
  "sessions": [
    {
      "session_id": "<string>",
      "task_name": "<string>",
      "browser_id": "<string>",
      "start_time": "2023-11-07T05:31:56Z",
      "is_online": true,
      "status": "running",
      "proxy_traffic_spent_bytes": 123
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

API key in the format 'x-api-key '

Query Parameters

​
browser_id
string

Filter sessions by browser ID

​
session_id
string

Filter sessions by session ID

​
task_name
string

Filter sessions by chat session title

​
sort-by
enum<string>

Field to sort results by

Available options:
start_time,
proxy_traffic_spent,
browsing_time
​
sort
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
limit
integer
default:50

Number of results to return

​
offset
integer
default:0

Number of results to skip

Response

Browser sessions retrieved successfully

​
sessions
object[]
​
total
integer

Total number of sessions matching the filters

​
limit
integer

Number of results returned

​
offset
integer

Number of results skipped