Skip to main content
GET
List browser sessions
默认:按时间戳倒序排列的最后 50 个会话
获取前 25 个已完成的会话
获取所有运行中的会话
获取所有失败的会话
从特定 API 区域获取会话
从特定日期范围获取会话
特定目标 URL 的会话,按带宽排序
特定目标 URL 的所有会话
特定目标 URL 的失败会话
按最高带宽排序的会话
按最长持续时间排序的会话
第一页(100 个会话)
第二页(接下来的 100 个会话)

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