Schedule a new backfill for a specific transfer. A backfill re-processes historical data for a specified date range.
Returns: The created backfill object with its ID, status, and progress information.
Important Notes:
- The transfer must exist and belong to your team
- You must have
dwh.transfer.editpermission - The date range cannot overlap with an existing active backfill
- Backfills are processed asynchronously
- The returned backfill object will have status "CREATED" initially
Bearer token authentication. Include the token in the Authorization header:
Authorization: Bearer <your-token>
Unique identifier of the team
Unique identifier of the transfer
Backfill creation parameters
{
"range_start": "2024-01-01",
"range_end": "2024-01-31"
}Start date of the backfill range (inclusive)
End date of the backfill range (inclusive)
Backfill successfully scheduled
{
"meta": {
"request_id": "01892A4D-7586-7000-8000-000000000000"
},
"data": {
"transfer_backfill_id": 12345,
"transfer_id": 456789,
"range_start_date": "2024-01-01",
"range_end_date": "2024-01-31",
"created_time": "2024-02-01T09:00:00Z",
"created_user_id": 789,
"start_time": null,
"end_time": null,
"status": "CREATED",
"transfer_runs_total": 31,
"transfer_runs_created": 0,
"transfer_runs_completed": 0,
"transfer_runs_failed": 0,
"error_report": []
}
}API request ID
Unique identifier of the backfill
ID of the transfer this backfill belongs to
Start date of the backfill range
End date of the backfill range
Timestamp when the backfill was created (ISO 8601 format)
ID of the user who created the backfill
Timestamp when the backfill was cancelled/removed (ISO 8601 format)
ID of the user who cancelled/removed the backfill
Timestamp when the backfill processing started (ISO 8601 format)
Timestamp when the backfill processing completed (ISO 8601 format)
Current status of the backfill
Total number of transfer runs created for this backfill
Number of transfer runs that have been created
Number of transfer runs that have completed successfully
Number of transfer runs that have failed
List of errors that occurred during backfill processing (empty array if no errors)
The date of the transfer run that failed
Error message describing what went wrong
Bad request - invalid parameters
RFC 9457 Problem Details for HTTP APIs
A URI reference that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Unauthorized - invalid or missing authentication
API request ID
Error code
Error message
Error description
Forbidden - The request is understood, but access is not allowed
{
"meta": {
"request_id": "01892A4D-7586-7000-8000-000000000000"
},
"error": {
"code": "ACCESS_DENIED",
"message": "Access Denied",
"description": "You do not have permission to perform this operation."
}
}API request ID
Error code
Error message
Error description
Transfer not found
{
"meta": {
"request_id": "01892A4D-7586-7000-8000-000000000000"
},
"error": {
"code": "NOT_FOUND",
"message": "Not Found",
"description": "The requested transfer could not be found or you do not have access to it."
}
}API request ID
Error code
Error message
Error description
Unprocessable Entity - request validation failed
API request ID
Error code
Error message
Error description
Too Many Requests - rate limit exceeded
API request ID
Error code
Error message
Error description
Internal Server Error - unexpected server error
API request ID
Error code
Error message
Error description