Validate transfer configuration

  • Updated on Mar 27, 2026
  • Published on Mar 18, 2026
Prev Next
Post
/teams/{team_id}/transfers/validations

Validates a configuration for a new Hub transfer.

Returns: List of validation errors (empty if valid).

Important Notes:

  • Use this endpoint before creating a transfer to check configuration validity
  • Returns field-level validation errors
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
Body parameters

Transfer configuration to validate

Expand All
object
data_source_id
string Required

Data source identifier

Max length50
ExampleAW
schema_id
integer (int32) Required

Schema identifier for the transfer

Example2
destination_id
integer (int32) Required

Destination identifier

Example8
display_name
string Required

Human-readable name for the transfer

Max length255
ExampleAW enhanced 2022-11-17
schedule
Array of object (TransferSchedule) Required

Transfer execution schedule configuration

object
Example{ "run_interval": "daily", "run_hour": 22, "refresh_window": 1 }
run_interval
string

Frequency of transfer execution

Valid values[ "hourly", "daily", "weekly", "monthly" ]
run_hour
integer (int32)

Hour of day to run (UTC)

Minimum0
Maximum23
refresh_window
integer (int32)

Number of days to refresh

Minimum1
run_weekday
integer (int32)

Day of week to run (1=Monday, 7=Sunday). Required for weekly interval.

Minimum1
Maximum7
run_day
integer (int32)

Day of month to run. Required for monthly interval.

Minimum1
Maximum31
accounts
Array of object (TransferAccount) Required

Data source accounts to include in transfer

object
Example{ "data_source_username": "user.name@supermetrics.com", "login_id": 2682599, "account_id": "8733197711" }
data_source_username
string

Username for data source authentication

Max length255
login_id
integer (int32)

Login identifier

account_id
string

Account identifier in the data source

Max length100
segments
Array of object (TransferSegment)

Data segments to include in transfer

object
Example{ "data_source_username": "user.name@supermetrics.com", "login_id": 2830506, "segment_id": "-1", "segment_name": "All users" }
data_source_username
string

Username for data source authentication

Max length255
login_id
integer (int32)

Login identifier

segment_id
string

Segment identifier

Max length100
segment_name
string

Human-readable segment name

Max length255
data_source_settings
Array of object (TransferDataSourceSetting)

Source-specific configuration settings

object
Example{ "field_id": "BRAND_KEYWORDS", "value": "", "group": "Default" }
field_id
string

Setting field identifier

Max length100
value

Setting value (type varies by field)

OneOf
string
string
boolean
boolean
integer
integer
group
string

Setting group identifier

Max length100
notification_recipients
Array of string

Email addresses to notify on transfer events

Example[ "user1@supermetrics.com", "user2@supermetrics.com" ]
string (email)
Max length255
transfer_type
integer (int32)

Transfer type identifier

Example1
Responses
200

Validation completed

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

Response from validating a transfer configuration

is_valid
boolean

Whether the configuration is valid

Exampletrue
errors
Array of object (ValidationError)

List of validation errors (empty if valid)

object

A single field validation error

field_id
string

The field that failed validation

Exampledisplay_name
error_code
string

The validation error code

ExampleisEmpty
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

© Supermetrics 2025