Skip to main content
GET
List browser sessions
Default: last 50 sessions sorted by timestamp desc
Get first 25 finished sessions
Get all running sessions
Get all failed sessions
Get sessions from a specific API zone
Sessions from a specific date range
Sessions for a specific target URL sorted by bandwidth
All sessions for a specific target URL
Failed sessions for a specific target URL
Sessions sorted by highest bandwidth
Sessions sorted by longest duration
First page (100 sessions)
Second page (next 100 sessions)

Authorizations

Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

  1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
  2. Include the API Key in the Authorization header of your requests
  3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Query Parameters

api_name
string

Name of the Browser API used

limit
integer
default:50

Number of sessions to return

Required range: x <= 100
offset
integer
default:0

Pagination offset

status
enum<string>
default:all

Filter by session status

Available options:
running,
finished,
failed,
all
start_date
string<date-time>

Start date filter

end_date
string<date-time>

End date filter

target_url
string

Filter by target url (e.g., example.com)

end_url
string

Filter by end url (e.g., https://www.example.com/example/sub)

sort
enum<string>
default:timestamp

Sort field: timestamp, duration, bandwidth

Available options:
timestamp,
duration,
bandwidth
order
enum<string>
default:desc

Sort order: asc or desc

Available options:
asc,
desc

Response

List of sessions

sessions
object[]
count
integer
total
integer
pagination
object