Get transfer run details

Updated on Mar 27, 2026
Published on Mar 18, 2026

Get

/teams/{team_id}/transfer_runs/{transfer_run_id}

Retrieve detailed information about a specific transfer run, including status, timestamps, duration, row counts, and per-query execution details.

Returns: The transfer run object with its ID, status, timing information, and query details.

Important Notes:

Requires scope dwh_transfers_read
Your account must have dwh.transfer.view permission. See roles and permissions.
The transfer run must exist and belong to your team
Returns 404 if the transfer run does not exist or does not belong to your team

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_run_id

integer (int64) Required

Unique identifier of the transfer run

Minimum1

Maximum9223372036854776000

Example12345

Responses

200

Transfer run retrieved successfully

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "data": {
    "id": 12345,
    "status": "COMPLETED",
    "started_time": "2024-01-15T10:00:00Z",
    "ended_time": "2024-01-15T10:05:30Z",
    "created_time": "2024-01-15T09:55:00Z",
    "queued_time": "2024-01-15T09:58:00Z",
    "query_details": [
      {
        "duration": 12.5,
        "status": "COMPLETED",
        "rows": 3000,
        "error_description": null
      },
      {
        "duration": 8.2,
        "status": "COMPLETED",
        "rows": 1500,
        "error_description": null
      }
    ],
    "external_id": "ext-12345",
    "failed_query_amount": 0,
    "total_duration": 330.5,
    "total_rows": 4500,
    "query_amount": 2,
    "data_date": "2024-01-15",
    "message": ""
  }
}

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

data

object (TransferRunDetail)

integer (int64)

Unique identifier of the transfer run

Minimum1

Example12345

status

string

Current status of the transfer run

ExampleCOMPLETED

started_time

string (date-time) | null

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

Example2024-01-15T10:00:00Z

ended_time

string (date-time) | null

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

Example2024-01-15T10:05:30Z

created_time

string (date-time) | null

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

Example2024-01-15T09:55:00Z

queued_time

string (date-time) | null

Timestamp when the transfer run was queued for processing (ISO 8601 format)

Example2024-01-15T09:58:00Z

query_details

Array of object (QueryDetails)

Per-query execution details for the transfer run

object

duration

number (float) | null

Duration of this query in seconds

Example12.5

status

string

Status of this query execution

ExampleCOMPLETED

rows

integer (int32)

Number of rows returned by this query

Minimum0

Example3000

error_description

string | null

Error description if the query failed

Example

external_id

string

External identifier of the transfer run

Exampleext-12345

failed_query_amount

integer (int32) | null

Number of queries that failed during the transfer run

Minimum0

Example0

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

query_amount

integer (int32) | null

Total number of queries executed during the transfer run

Minimum0

Example5

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

404

Transfer run not found

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "error": {
    "code": "NOT_FOUND",
    "message": "Not Found",
    "description": "The requested transfer run could not be found or you do not have access to it."
  }
}

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

Was this article helpful?