BigQuery API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "bigquery_db",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "SOURCE_NAMING",
  "config": {
    "secret_key": "secretKey",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "project_id": "projectId",
    "data_set_name": "dataSetName",
    "workspace_same_as_source": true,
    "use_service_account": true,
    "quota_project_id": "my-quota-project",
    "workspace_name": "string",
    "use_workspace": true,
    "schema_prefix": "prefix"
  }
}

Config parameters

Name	Description
`secret_key`	Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
`connection_type`	Direct or PrivateLink connection
`project_id`	BigQuery project ID
`data_set_name`	Data set name
`workspace_same_as_source`	Use the source dataset as the workspace dataset
`use_service_account`	BigQuery use service account; default is false
`quota_project_id`	Specify a different project ID to account for quota and billing of Fivetran query workload
`workspace_name`	Workspace Dataset Name
`use_workspace`	Create and drop tables in a query results dataset. Default is false
`schema_prefix` (required)	Destination schema prefix. Prefix for each replicated schema. For example with prefix 'x', source schemas 'foo' and 'bar' get replicated as 'x_foo' and 'x_bar'. The prefix is permanent and cannot be changed after connection creation

Authorization

This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.