Skip to main content
GET
/
domains
/
{metric}
Domain usage metrics
curl --request GET \
  --url https://api.brightdata.com/domains/{metric} \
  --header 'Authorization: Bearer <token>'
{}

​
Sample Requests

curl --request GET \
  --url 'api.brightdata.com/domains/bw?from=2025-12-01&to=2025-12-10' \
  --header 'Authorization: Bearer API_TOKEN'

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:

Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

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

Path Parameters

​
metric
enum<string>
required

Metric type to query:

Available Metrics

  • /bw - Bandwidth consumption
  • /req - Request count
Available options:
bw,
req

Query Parameters

​
from
string<date>
required

Start date (YYYY-MM-DD)

Example:

"2025-12-01"

​
to
string<date>
required

End date (YYYY-MM-DD)

Example:

"2025-12-10"

​
zones
string

Zone name filter. Omit to include all zones.

Example:

"zone_name"

Response

Successful response

The response is of type object.