List transfer runs

Prev Next
Get
/teams/{team_id}/transfers/{transfer_id}/runs

Retrieve a paginated, filterable list of transfer runs for a specific transfer. Supports date range filtering, issue filtering, sorting, and pagination.

Returns: Array of transfer run objects.

Important Notes:

  • Requires scope dwh_transfers_read
  • Your account must have dwh.transfer.view permission. See roles and permissions.
  • The transfer must exist and belong to your team
  • Start date and end date are required parameters
  • Results are paginated (default limit: 100, max: 10000)
Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Path parameters
team_id
integer (int64) Required

Unique identifier of the team

Minimum1
Maximum9223372036854776000
Example12345
transfer_id
integer (int64) Required

Unique identifier of the transfer

Minimum1
Maximum9223372036854776000
Example456789
Query parameters
start_date
string (date-time) Required

Start date for filtering runs (inclusive)

Example2024-01-01T00:00:00Z
end_date
string (date-time) Required

End date for filtering runs (inclusive)

Example2024-01-31T23:59:59Z
filter_issues_only
boolean

Filter to show only runs with issues

Examplefalse
sort_field
string

Field to sort by

Valid values[ "created_time", "ended_time", "data_date" ]
Examplecreated_time
sort_direction
string

Sort direction

Valid values[ "ASC", "DESC" ]
ExampleDESC
limit
integer (int32)

Maximum number of results to return (default 100, max 10000)

Minimum1
Default100
Example100
offset
integer (int32)

Number of results to skip for pagination

Minimum0
Default0
Example0
Responses
200

Transfer runs retrieved successfully

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

Multiple transfer runs

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "data": [
    {
      "id": 12345,
      "status": "COMPLETED",
      "created_time": "2024-01-15T09:55:00Z",
      "ended_time": "2024-01-15T10:05:30Z",
      "type": "Recurring",
      "total_duration": 330.5,
      "total_rows": 4500,
      "data_date": "2024-01-15",
      "message": ""
    },
    {
      "id": 12344,
      "status": "FAILED",
      "created_time": "2024-01-14T09:55:00Z",
      "ended_time": "2024-01-14T10:02:00Z",
      "type": "Recurring",
      "total_duration": 420,
      "total_rows": 0,
      "data_date": "2024-01-14",
      "message": "Connection timeout to data source"
    },
    {
      "id": 12343,
      "status": "COMPLETED",
      "created_time": "2024-01-13T14:00:00Z",
      "ended_time": "2024-01-13T14:08:15Z",
      "type": "Backfill",
      "total_duration": 495,
      "total_rows": 8200,
      "data_date": "2024-01-13",
      "message": ""
    }
  ]
}
emptyList

No transfer runs found

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

API request ID

Max length50
Pattern^[A-Za-z0-9_-]+$
data
Array of object (TransferRunItem)

Array of transfer run objects

object
id
integer (int64)

Unique identifier of the transfer run

Minimum1
Example12345
status
string

Current status of the transfer run

ExampleCOMPLETED
created_time
string (date-time) | null

Timestamp when the transfer run was created (ISO 8601 format)

Example2024-01-15T09:55:00Z
ended_time
string (date-time) | null

Timestamp when the transfer run finished processing (ISO 8601 format)

Example2024-01-15T10:05:30Z
type
string

Type of the transfer run

Valid values[ "Recurring", "Backfill" ]
ExampleRecurring
total_duration
number (float) | null

Sum of all query durations in seconds

Example330.5
total_rows
integer (int32) | null

Total number of rows processed during the transfer run

Minimum0
Example15000
data_date
string (date) | null

The data date this transfer run covers

Example2024-01-15
message
string

Status message or error description for the transfer run

Example
401

Unauthorized - Authentication is required and has failed or has not been provided.

Headers
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
{
  "meta": {
    "request_id": "019461A0-0000-7000-8000-000000000000"
  },
  "error": {
    "code": "API_KEY_INVALID",
    "message": "Invalid API key",
    "description": "Provided API key was invalid."
  }
}
Expand All
object
meta
object (ResponseMeta)
request_id
string

API request ID

Max length50
Pattern^[A-Za-z0-9_-]+$
error
object (Error)
code
string

Error code

Max length100
message
string

Error message

Max length255
description
string

Error description

Max length255
403

Forbidden - The request is understood, but access is not allowed

Headers
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
{
  "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."
  }
}
Expand All
object
meta
object (ResponseMeta)
request_id
string

API request ID

Max length50
Pattern^[A-Za-z0-9_-]+$
error
object (Error)
code
string

Error code

Max length100
message
string

Error message

Max length255
description
string

Error description

Max length255
429

Too Many Requests - Rate limit exceeded.

Headers
Retry-After
integer
Number of seconds to wait before making another request
Minimum1
Maximum3600
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
{
  "meta": {
    "request_id": "019461A0-0000-7000-8000-000000000000"
  },
  "error": {
    "code": "API_ROW_QUOTA_EXCEEDED",
    "message": "Row quota exceeded",
    "description": "You have exceeded your row-quota limit of rows for this month. Please log into Supermetrics Hub at https://hub.supermetrics.com/ and upgrade your plan, or contact our Supermetrics support team."
  }
}
Expand All
object
meta
object (ResponseMeta)
request_id
string

API request ID

Max length50
Pattern^[A-Za-z0-9_-]+$
error
object (Error)
code
string

Error code

Max length100
message
string

Error message

Max length255
description
string

Error description

Max length255
500

Internal Server Error - An error occurred on the server.

Headers
Access-Control-Allow-Origin
string
CORS header
Valid values[ "*" ]
Max length255
Example*
{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Internal Server Error",
    "description": "An unexpected error occurred. Please try again later or contact support."
  }
}
Expand All
object
meta
object (ResponseMeta)
request_id
string

API request ID

Max length50
Pattern^[A-Za-z0-9_-]+$
error
object (Error)
code
string

Error code

Max length100
message
string

Error message

Max length255
description
string

Error description

Max length255