Dataset API Error Status Documentation
400 - Bad Request
Indicates that the request was invalid or cannot be processed.
| Error Message | Cause |
|---|---|
{validation_errors: ["filter.name is required"]} | The request is missing a required filter parameter (e.g., filter.name). |
{validation_errors: ["Invalid input provided"]} | The input provided in the request is not valid. |
Type ${init_types.compr_update} is no longer supported. Use '${init_types.discover_all}' instead. | The requested operation type is deprecated. |
Type ${init_types.update_existing} is no longer supported. | The requested operation type is no longer supported. |
Type ${init_types.discover_new} is no longer supported. | The requested operation type is no longer supported. |
Initiation reason is required. | The request is missing the required initiation reason. |
This feature is not available. | The requested feature is not supported for the dataset. |
This dataset was rejected. | The dataset was rejected and cannot be processed. |
This dataset is not ready. | The dataset is not in a state where it can be processed. |
This dataset does not support discovery. Supported types: ['${init_types.url_collection}'] | The dataset does not support the requested discovery type. |
Incorrect discovery collector id. | The discovery collector ID provided in the request is invalid. |
View not found. | The requested view is not available. |
This dataset does not support collection. | The dataset does not support the requested collection operation. |
Batch size must be at least 1000. | The batch size specified in the request is below the minimum allowed value. |
{error: 'Snapshot failed'} | The snapshot operation failed. |
{error: 'Snapshot not ready'} | The snapshot is not ready for processing. |
{error: 'Invalid snapshot type'} | The snapshot type provided in the request is invalid. |
{validation_errors: [e.message]} | A validation error occurred, and the specific message is included in the response. |
401 - Unauthorized
Indicates that the user is not authorized to access the requested resource.
| Error Message | Cause |
|---|---|
Unauthorized | The API key or authentication credentials provided are invalid or missing. |
402 - Payment Required
Indicates that the user does not have sufficient funds to process the request.
| Error Message | Cause |
|---|---|
{error: 'Your current balance is insufficient to process this data collection request. Please add funds to your account or adjust your request to continue. ($220 is missing)'} | The user’s account balance is insufficient to process the request. |
403 - Forbidden
Indicates that the user does not have permission to access the requested resource.
| Error Message | Cause |
|---|---|
Access denied. | The user does not have the necessary permissions to access the resource. |
Cannot skip billing. | The user attempted to skip billing, which is not allowed. |
404 - Not Found
Indicates that the requested resource could not be found.
| Error Message | Cause |
|---|---|
{error: 'Dataset not found'} | The specified dataset ID does not exist. |
{error: 'Snapshot not found'} | The specified snapshot ID does not exist. |
Dataset does not exist. | The dataset referenced in the request does not exist. |
Request not found. | The specified request ID does not exist. |
422 - Unprocessable Entity
Indicates that the request was well-formed but could not be processed due to semantic errors.
| Error Message | Cause |
|---|---|
{error: 'Provided filter did not match any records'} | The filter provided in the request did not match any records in the dataset. |
429 - Too Many Requests
Indicates that the user has exceeded the rate limit or the maximum number of parallel jobs.
| Error Message | Cause |
|---|---|
{error: 'Maximum limit of ${max_parallel_jobs} jobs per dataset has been exceeded'} | The user has exceeded the maximum allowed number of parallel jobs for the dataset. |
500 - Internal Server Error
Indicates that an unexpected error occurred on the server.
| Error Message | Cause |
|---|---|
Internal error. | An unexpected error occurred on the server. |
502 - Bad Gateway
Indicates that the server received an invalid response from an upstream server.
| Error Message | Cause |
|---|---|
| Unexpected error. | The server encountered an unexpected error while processing the request. |
Appendix
Sources:
- http://cvs.brightdata.com/cvs/zon/pkg/www/dca/pub/util.js?rev=1.197
- pkg/www/dca/dataset_ext_api.js
Some error codes (e.g., 400, 404) may have multiple causes, as outlined above.
Error messages are designed to provide clear feedback to users about the issue and how to resolve it.
For errors with dynamic content (e.g., balance or job limits), placeholders like${max_parallel_jobs}or${init_types}are replaced with actual values at runtime.