Skip to main content
GET
/
webarchive
/
search
/
{search_id}
Get search status
curl --request GET \
  --url https://api.brightdata.com/webarchive/search/{search_id} \
  --header 'Authorization: Bearer <token>'
{
  "search_id": "ucd_abc123xyz",
  "status": "in_progress"
}

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.

When successful it will retrieve:
  • The number of entries for your query
  • The estimated size and cost of the full Data Snapshot
Pricing & size: estimate_batch_size is measured in bytes. dump_cost_usd is an estimated total cost based on files_count and your current cache/archive pricing tier. The cost_breakdown object shows separate costs for cache vs archive pages.

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

​
search_id
string
required

Unique identifier for the search

Example:

"ucd_abc123xyz"

Response

Search status response

​
search_id
string

Unique identifier for the search

​
status
enum<string>

Current status: in_progress, done, or failed

Available options:
done
​
filters
object

The filters used for this search (echoed back)

​
files_count
integer

Total number of matching files found

​
estimate_batch_count
integer

Estimated number of batches for the dump

​
estimate_batch_size
integer

Estimated total size in bytes

​
dump_cost_usd
number

Estimated total cost to create a dump

​
cost_breakdown
object

Breakdown of costs between cache and archive pages

​
estimate_dump_duration_sec
integer

Estimated time to complete the dump in seconds

​
duration
string

How long the search took to complete

​
error
string

Error message (only present when status is failed)