Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt

Use this file to discover all available pages before exploring further.

The bandwidth is calculated according to the sum of data transmitted to and from the target site: request headers + request data (POST) + response headers+response data.\
The traffic used during your trial will be listed on your dashboard but will not be counted towards your bill.
API endpoint: GET /api/zone/bwOptional parameters: from=2018-07-01T00:00:00&to=2018-07-02T00:00:00
curl "https://api.brightdata.com/zone/bw?zone=ZONE" -H "Authorization: Bearer API_KEY"
Sample Response
{
  "ID:": {
    "customer_id": "customer_id",
    "from": "2022-10-01T00:00:00.000Z",
    "to": "2022-11-23T00:00:00.000Z",
    "data": {
      "static": {
        "bw_sum": [
            0, 745, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6960, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
        ],
        "bw_dn": [
            0, 525, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5990, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
        ],
        "bw_up": [
            0, 220, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 970, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
        ],
        "http_direct_req": [
            0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
        ],
        "bw_sum_dc": [
            0, 745, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6960, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
        ],
        "bw_api": [
            0, 745, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6960, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
        ],
        "https_direct_req": [
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
        ]
      }
    },
    "last_value_ts": "2022-11-19T19:1* Connection #0 to host brightdata.com left intact 8:51.546Z",
    "last_update_ts": "2022-11-22T11:35:32.122Z",
    "sums": {
      "static": {
        "back_m1": {
          "bw_sum": 745,
          "bw_dn": 525,
          "bw_up": 220,
          "http_direct_req": 1,
          "bw_sum_dc": 745,
          "bw_api": 745,
          "https_direct_req": 0
        },
        "back_m0": {
          "bw_sum": 6960,
          "bw_dn": 5990,
          "bw_up": 970,
          "http_direct_req": 0,
          "bw_sum_dc": 6960,
          "bw_api": 6960,
          "https_direct_req": 1
        },
        "back_d2": {
          "bw_sum": 0,
          "bw_dn": 0,
          "bw_up": 0,
          "http_direct_req": 0,
          "bw_sum_dc": 0,
          "bw_api": 0,
          "https_direct_req": 0
        },
        "back_d1": {
          "bw_sum": 0,
          "bw_dn": 0,
          "bw_up": 0,
          "http_direct_req": 0,
          "bw_sum_dc": 0,
          "bw_api": 0,
          "https_direct_req": 0
        },
        "back_d0": {
          "bw_sum": 0,
          "bw_dn": 0,
          "bw_up": 0,
          "http_direct_req": 0,
          "bw_sum_dc": 0,
          "bw_api": 0,
          "https_direct_req": 0
        }
      }
    }
  }
}
API endpoint: GET /api/customer/bwOptional parameters: from=2018-07-01T00:00:00&to=2018-07-02T00:00:00
curl "https://api.brightdata.com/customer/bw" -H "Authorization: Bearer API_KEY"
API endpoint: GET /api/zone/costOptional parameters: from=2018-07-01T00:00:00&to=2018-07-02T00:00:00
curl "https://api.brightdata.com/zone/cost?zone=ZONE" -H "Authorization: Bearer API_KEY"
Sample Response
Example response:  
{
  "ID": {
    "back_m2": {
      "bw": 0,
      "cost": 0
    },
    "back_m1": {
      "bw": 36557298,
      "cost": 0
    },
    "back_m0": {
      "bw": 1219004,
      "cost": 0
    },
    "back_d2": {
      "bw": 82190,
      "cost": 0
    },
    "back_d1": {
      "bw": 0,
      "cost": 0
    },
    "back_d0": {
      "bw": 0,
      "cost": 0
    }
  }
}