cURL
curl --request GET \
--url https://api.brightdata.com/datasets/v3/progress/{snapshot_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.brightdata.com/datasets/v3/progress/{snapshot_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.brightdata.com/datasets/v3/progress/{snapshot_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.brightdata.com/datasets/v3/progress/{snapshot_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.brightdata.com/datasets/v3/progress/{snapshot_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.brightdata.com/datasets/v3/progress/{snapshot_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brightdata.com/datasets/v3/progress/{snapshot_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"snapshot_id": "<string>",
"dataset_id": "<string>",
"status": "starting"
}管理 API
监控进度
使用 Bright Data Scraper API 管理端点监控进度。GET /datasets/v3/progress/ 以 JSON 返回快照或任务状态。
GET
/
datasets
/
v3
/
progress
/
{snapshot_id}
cURL
curl --request GET \
--url https://api.brightdata.com/datasets/v3/progress/{snapshot_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.brightdata.com/datasets/v3/progress/{snapshot_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.brightdata.com/datasets/v3/progress/{snapshot_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.brightdata.com/datasets/v3/progress/{snapshot_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.brightdata.com/datasets/v3/progress/{snapshot_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.brightdata.com/datasets/v3/progress/{snapshot_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brightdata.com/datasets/v3/progress/{snapshot_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"snapshot_id": "<string>",
"dataset_id": "<string>",
"status": "starting"
}- 异步用法: 通过异步端点(
/trigger)触发数据采集任务,获得snapshot_id,轮询监控进度 API 直到状态为 ready,然后下载结果。 - 同步用法: 如果同步请求(
/scrape)超过 1 分钟超时,会获得snapshot_id,可用于轮询监控进度 API,并在结果就绪后下载。
如果请求耗时过长,建议改用异步请求。
授权
在 Authorization 头中使用您的 Bright Data API Key 作为 Bearer token。
认证方法:
- 从 Bright Data 账户设置获取您的 API Key: https://brightdata.com/cp/setting/users
- 在请求的 Authorization 头中包含 API Key
- 格式:
Authorization: Bearer YOUR_API_KEY
示例:
Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df
了解如何获取 Bright Data API Key: https://docs.brightdata.com/cn/api-reference/authentication#如何生成新的-api-key?
路径参数
触发采集时返回的 ID
示例:
"s_m4x7enmven8djfqak"
响应
成功
当 status 为 failed 时,error_message 为以下之一:
- Something went wrong. Our team is looking into it. 出现问题,团队正在处理
- Account is suspended 账户已被暂停
- Account is new, please activate it in account settings. URL 账户为新账户,请在账户设置中激活
- No data found in discovery 发现中未找到数据
- Snapshot is empty 快照为空
- Failed to deliver snapshot 快照交付失败
- Failed to download response 下载响应失败
- Failed to trigger collector 触发收集器失败
- Internal Server Error 内部服务器错误
- Input validation failed: DETAILS 输入验证失败: DETAILS
此页面对您有帮助吗?