List incomplete backfills for team

Prev Next
Get
/teams/{team_id}/backfills

Retrieve a list of all incomplete backfills for your team. This endpoint returns only backfills that are not yet finished.

What are "incomplete" backfills?

  • Included: Backfills with status CREATED, SCHEDULED, RUNNING, or FAILED
  • Excluded: Backfills with status COMPLETED or CANCELLED

Returns: Array of backfill objects sorted by creation time (newest first).

Important Notes:

  • You must have dwh.transfer.view permission
  • Only backfills belonging to your team are returned
  • The list includes backfills for all transfers in your team
  • Each backfill includes real-time progress tracking for running backfills

Rate limited: calls to this endpoint within 200ms of the team's previous call return 429. Every call that passes authentication and access checks and isn't itself rate-limited starts the window, even if it then fails (e.g. 404). The window is shared by all API keys and access tokens of the team, and does not depend on resource IDs in the path.

Security
HTTP
Type bearer

API key authentication. Create API keys in the Supermetrics Hub and send them in the Authorization header: Authorization: Bearer <your-api-key>

Path parameters
team_id
integer (int64) Required

ID of the team

Minimum1
Maximum9223372036854776000
Example936506
Responses
200

List of incomplete backfills retrieved successfully

Headers
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
multipleBackfills

Multiple incomplete backfills

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "data": [
    {
      "transfer_backfill_id": 12347,
      "transfer_id": 456790,
      "range_start_date": "2024-02-01",
      "range_end_date": "2024-02-28",
      "created_time": "2024-03-01T14:00:00Z",
      "created_user_id": 789,
      "start_time": "2024-03-01T14:30:00Z",
      "end_time": null,
      "status": "RUNNING",
      "transfer_runs_total": 28,
      "transfer_runs_created": 28,
      "transfer_runs_completed": 15,
      "transfer_runs_failed": 0,
      "error_report": []
    },
    {
      "transfer_backfill_id": 12346,
      "transfer_id": 456789,
      "range_start_date": "2024-01-15",
      "range_end_date": "2024-01-31",
      "created_time": "2024-02-15T09:30:00Z",
      "created_user_id": 790,
      "start_time": "2024-02-15T10:00:00Z",
      "end_time": null,
      "status": "RUNNING",
      "transfer_runs_total": 17,
      "transfer_runs_created": 17,
      "transfer_runs_completed": 10,
      "transfer_runs_failed": 0,
      "error_report": []
    },
    {
      "transfer_backfill_id": 12345,
      "transfer_id": 456788,
      "range_start_date": "2024-01-01",
      "range_end_date": "2024-01-14",
      "created_time": "2024-02-01T08:00:00Z",
      "created_user_id": 789,
      "start_time": null,
      "end_time": null,
      "status": "SCHEDULED",
      "transfer_runs_total": 14,
      "transfer_runs_created": 14,
      "transfer_runs_completed": 0,
      "transfer_runs_failed": 0,
      "error_report": []
    }
  ]
}
emptyList

No incomplete backfills

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "data": []
}
Expand All
object

Response envelope containing a list of incomplete backfills.

meta
object (Meta)

Metadata included in every API response.

request_id
string

Unique identifier for the request, for tracking and debugging.

Min length8
Max length64
Pattern^[A-Za-z0-9_-]+$
ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN
data
Array of object (Backfill)

Array of incomplete backfill objects

Max items100
object
transfer_backfill_id
integer (int64)

Unique identifier of the backfill

Minimum1
Maximum9223372036854776000
Example12345
transfer_id
integer (int64)

ID of the transfer this backfill belongs to

Minimum1
Maximum9223372036854776000
Example456789
range_start_date
string (date)

Start date of the backfill range

Max length10
Example2024-01-01
range_end_date
string (date)

End date of the backfill range

Max length10
Example2024-01-31
created_time
string (date-time)

Timestamp when the backfill was created (ISO 8601 format)

Max length30
Example2024-02-01T09:00:00Z
created_user_id
integer (int64)

ID of the user who created the backfill

Minimum1
Maximum9223372036854776000
Example789
removed_time
string (date-time) | null

Timestamp when the backfill was cancelled/removed (ISO 8601 format)

Max length30
Example2024-02-01T15:00:00Z
removed_user_id
integer (int64) | null

ID of the user who cancelled/removed the backfill

Minimum1
Maximum9223372036854776000
Example790
start_time
string (date-time) | null

Timestamp when the backfill processing started (ISO 8601 format)

Max length30
Example2024-02-01T10:00:00Z
end_time
string (date-time) | null

Timestamp when the backfill processing completed (ISO 8601 format)

Max length30
Example2024-02-01T12:30:00Z
status
string

Current status of the backfill

Valid values[ "CREATED", "SCHEDULED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED" ]
ExampleRUNNING
transfer_runs_total
integer (int32)

Total number of transfer runs created for this backfill

Minimum0
Maximum2147483647
Example31
transfer_runs_created
integer (int32)

Number of transfer runs that have been created

Minimum0
Maximum2147483647
Example31
transfer_runs_completed
integer (int32)

Number of transfer runs that have completed successfully

Minimum0
Maximum2147483647
Example25
transfer_runs_failed
integer (int32)

Number of transfer runs that have failed

Minimum0
Maximum2147483647
Example2
error_report
Array of object (TransferBackfillRunError)

List of errors that occurred during backfill processing (empty array if no errors)

Max items100
object
transfer_run_date
string (date)

The date of the transfer run that failed

Max length10
Example2024-01-15
error
string

Error message describing what went wrong

Max length1000
ExampleConnection timeout to data source
401

Unauthorized

Headers
WWW-Authenticate
string
Bearer token required
Max length255
Pattern^Bearer.*
X-RateLimit-Limit
integer (int32)
Request limit per hour
Minimum1
Maximum10000
Example5000
X-RateLimit-Remaining
integer (int32)
Remaining requests in current window
Minimum0
Maximum10000
Example4999
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required."
  }
}
Expand All
object

Standard envelope returned by all error (4xx/5xx) responses.

meta
object (Meta)

Metadata included in every API response.

request_id
string

Unique identifier for the request, for tracking and debugging.

Min length8
Max length64
Pattern^[A-Za-z0-9_-]+$
ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN
error
object (Error)

Machine- and human-readable detail for a failed request.

code
string

Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.

Max length100
Pattern^[A-Z][A-Z0-9_]*$
ExampleBAD_REQUEST
message
string

Short, human-readable summary of the error.

Max length255
Pattern^.+$
ExampleThe request was invalid.
description
string

Optional longer explanation specific to this occurrence.

Max length2048
ExampleThe field 'display_name' must not be empty.
403

Access forbidden

Headers
X-RateLimit-Limit
integer (int32)
Request limit per hour
Minimum1
Maximum10000
Example5000
X-RateLimit-Remaining
integer (int32)
Remaining requests in current window
Minimum0
Maximum10000
Example4999
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this resource."
  }
}
Expand All
object

Standard envelope returned by all error (4xx/5xx) responses.

meta
object (Meta)

Metadata included in every API response.

request_id
string

Unique identifier for the request, for tracking and debugging.

Min length8
Max length64
Pattern^[A-Za-z0-9_-]+$
ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN
error
object (Error)

Machine- and human-readable detail for a failed request.

code
string

Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.

Max length100
Pattern^[A-Z][A-Z0-9_]*$
ExampleBAD_REQUEST
message
string

Short, human-readable summary of the error.

Max length255
Pattern^.+$
ExampleThe request was invalid.
description
string

Optional longer explanation specific to this occurrence.

Max length2048
ExampleThe field 'display_name' must not be empty.
429

Too Many Requests

Headers
X-RateLimit-Limit
integer (int32)
Request limit per hour
Minimum1
Maximum10000
Example5000
X-RateLimit-Remaining
integer (int32)
Remaining requests in current window
Minimum0
Maximum10000
Example4999
Retry-After
integer (int32)
Seconds until rate limit resets
Minimum1
Maximum86400
Example3600
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "TOO_MANY_REQUESTS",
    "message": "Rate limit exceeded. Retry later."
  }
}
Expand All
object

Standard envelope returned by all error (4xx/5xx) responses.

meta
object (Meta)

Metadata included in every API response.

request_id
string

Unique identifier for the request, for tracking and debugging.

Min length8
Max length64
Pattern^[A-Za-z0-9_-]+$
ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN
error
object (Error)

Machine- and human-readable detail for a failed request.

code
string

Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.

Max length100
Pattern^[A-Z][A-Z0-9_]*$
ExampleBAD_REQUEST
message
string

Short, human-readable summary of the error.

Max length255
Pattern^.+$
ExampleThe request was invalid.
description
string

Optional longer explanation specific to this occurrence.

Max length2048
ExampleThe field 'display_name' must not be empty.
500

Internal server error

Headers
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred."
  }
}
Expand All
object

Standard envelope returned by all error (4xx/5xx) responses.

meta
object (Meta)

Metadata included in every API response.

request_id
string

Unique identifier for the request, for tracking and debugging.

Min length8
Max length64
Pattern^[A-Za-z0-9_-]+$
ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN
error
object (Error)

Machine- and human-readable detail for a failed request.

code
string

Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.

Max length100
Pattern^[A-Z][A-Z0-9_]*$
ExampleBAD_REQUEST
message
string

Short, human-readable summary of the error.

Max length255
Pattern^.+$
ExampleThe request was invalid.
description
string

Optional longer explanation specific to this occurrence.

Max length2048
ExampleThe field 'display_name' must not be empty.