Skip to main content
GET
cURL
The Bright Data Web Unlocker API success rate endpoint returns the share of requests that succeeded against a domain, as a number between 0 and 1. By default the reporting window is the past 7 days. Pass a single domain such as example.com to get one figure. Pass a wildcard such as example.* to get one figure for every monitored top-level domain of that name.

How do I filter success rates by date range or URL?

Add the optional from_datetime, to_datetime and url_pattern query parameters. Each one works on its own or combined with the others:
  • from_datetime and to_datetime set the reporting window. Both accept an ISO 8601 UTC date such as 2026-09-20 or a date-time such as 2026-09-20T00:00:00Z.
  • url_pattern keeps only requests whose URL contains the string. The match is a case-insensitive substring match and works with wildcard domains.
The following request returns the success rate for example.com requests whose URL contains /ip/, between September 20 and September 24, 2026:
The request fails when from_datetime is later than to_datetime or when a date cannot be parsed. Related guide: Web Unlocker API features

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

Path Parameters

domain
string
required

Domain to report on. Use a single domain such as example.com, or a wildcard such as example.* to return every monitored top-level domain.

Example:

"example.com"

Query Parameters

from_datetime
string

Start of the reporting window, in ISO 8601 UTC format. Accepts a date such as 2026-09-20 or a date-time such as 2026-09-20T00:00:00Z. You can pass from_datetime on its own or together with to_datetime. The request fails when from_datetime is later than to_datetime or when a value cannot be parsed.

Example:

"2026-09-20T00:00:00Z"

to_datetime
string

End of the reporting window, in ISO 8601 UTC format. Accepts a date such as 2026-09-24 or a date-time such as 2026-09-24T00:00:00Z. You can pass to_datetime on its own or together with from_datetime.

Example:

"2026-09-24"

url_pattern
string

Return statistics only for requests whose URL contains this string. The match is a case-insensitive substring match, so /ip/ matches any request URL containing /ip/ or /IP/. Works with wildcard domains such as example.*.

Example:

"/ip/"

Response

OK

Map of domain to success rate over the reporting window, as a number between 0 and 1.

{key}
number