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, plus time_p90, the 90th percentile response time in milliseconds. By default the reporting window is the past 7 days.

Which domains can I query?

Pass one domain or a wildcard in the {domain} path segment:
  • example.com returns one figure for that domain.
  • example.* returns one figure for every monitored domain that starts with example., such as example.org and example.de.
  • *.example.com returns one figure for every monitored subdomain of example.com, such as api.example.com.

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-10-12 or a date-time such as 2026-10-12T00:00:00Z. A date on its own means midnight UTC at the start of that day, so to_datetime=2026-10-19 covers requests up to the end of October 18.
  • url_pattern keeps only requests whose URL contains the string. The match is case-insensitive and works with wildcard domains.
The following request returns the success rate and p90 response time for example.com requests whose URL contains /ip/, between October 12 and October 19, 2026:
The response holds one key per domain and one time_p90 key:

What does the response contain?

The response is a JSON object with two kinds of keys:
  • One key per domain. The value is the success rate over the reporting window, from 0 (no request succeeded) to 1 (every request succeeded). 0.9639 means 96.39 percent of requests succeeded.
  • time_p90. The 90th percentile (p90) response time in milliseconds for the requests in the window. The response has one time_p90 value, not one per domain, including for wildcard queries.

What is p90 response time?

The p90 response time is the time within which 90 percent of requests finished. A time_p90 of 3347.98 means 90 percent of requests completed in 3,348 milliseconds (about 3.3 seconds) or less, and the slowest 10 percent took longer. The p90 is more useful than an average for planning timeouts, because a few very slow requests can pull an average up or down. Set your client timeout above the time_p90 value so that at least 90 percent of requests can finish.

What happens when no data matches?

The endpoint returns HTTP 200 with an empty object {} when no requests match the query. This happens when the domain has no monitored traffic, when url_pattern matches no request URL, or when from_datetime is the same as or later than to_datetime.
Queries over large domains or long windows can take more than 60 seconds to return. Set your HTTP client timeout to at least 120 seconds and send queries one at a time.
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, a wildcard such as example.* to return every monitored domain that starts with example., or *.example.com to return every monitored subdomain of example.com.

Example:

"example.com"

Query Parameters

from_datetime
string

Start of the reporting window, in ISO 8601 UTC format. Accepts a date such as 2026-10-12 or a date-time such as 2026-10-12T00:00:00Z. A date on its own means midnight UTC at the start of that day. You can pass from_datetime on its own or together with to_datetime. When from_datetime is the same as or later than to_datetime, the response is an empty object {}.

Example:

"2026-10-12"

to_datetime
string

End of the reporting window, in ISO 8601 UTC format. Accepts a date such as 2026-10-19 or a date-time such as 2026-10-19T00:00:00Z. A date on its own means midnight UTC at the start of that day, so 2026-10-19 covers requests up to the end of October 18. You can pass to_datetime on its own or together with from_datetime.

Example:

"2026-10-19"

url_pattern
string

Return statistics only for requests whose URL contains this string. The match is case-insensitive, so /ip/ matches any request URL containing /ip/ or /IP/. Works with wildcard domains such as example.*. When no request URL matches, the response is an empty object {}.

Example:

"/ip/"

Response

Success rate per domain plus one time_p90 value. An empty object {} means no requests matched the query.

JSON object with one key per domain and one time_p90 key. Each domain key holds the success rate over the reporting window, as a number between 0 and 1. time_p90 is the 90th percentile response time in milliseconds: 90 percent of requests in the window finished within this time. The response has one time_p90 value, not one per domain, including for wildcard queries.

time_p90
number

90th percentile (p90) response time in milliseconds for the requests in the reporting window. 90 percent of requests finished within this time and the slowest 10 percent took longer.

Example:

3347.98323864866

{key}
number

Success rate for this domain over the reporting window, as a number between 0 and 1.