The connector setup configuration (config
field) is different for each connector.
Below are several examples of key connectors to help get you started.
We will continue to add more connectors to this list throughout BETA:
- Adjust
- Adobe Analytics
- Adobe Analytics Data Feed
- ADP Workforce Now
- AdRoll
- Airtable
- Amazon Ads
- Amazon Kinesis Firehose
- Amazon S3
- Amplitude
- Anaplan
- Apache Kafka
- Apple App Store
- Apple Search Ads
- AppsFlyer
- Asana
- AWS CloudTrail
- AWS Inventory
- AWS Lambda
- AWS MSK
- Azure Blob Storage
- Azure Functions
- Azure Event Hubs
- Box
- Braintree
- Branch
- Braze
- CloudFront
- Confluent Cloud
- Coupa
- Criteo
- Delighted
- Dropbox
- DynamoDB
- Eloqua
- Facebook Ad Account
- Facebook Ad Insights
- Facebook Ads
- Facebook Pages
- FinancialForce
- Fivetran Log Connector
- Freshdesk
- Front
- FTP/FTPS
- Gainsight Customer Success
- GitHub
- Google Ad Manager
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 4 Export
- Google Analytics 360
- Google Analytics (MCF)
- Google Campaign Manager 360
- Google Cloud Functions
- Google Cloud Storage
- Google Display & Video 360
- Google Drive
- Google Play
- Google Search Console
- Google Sheets
- Greenhouse
- Heap
- Height
- Help Scout
- Heroku Kafka
- HubSpot
- Instagram Business
- Intercom
- Iterable
- Jira
- Klaviyo
- Kustomer
- Lever
- Lightspeed Retail
- LinkedIn Ad Analytics
- LinkedIn Company Pages
- Mailchimp
- Mandrill
- MariaDB
- Marin Software
- Marketo
- Mavenlink
- Medallia
- Microsoft Advertising
- Microsoft Dynamics 365
- Microsoft Dynamics 365 F/O
- Microsoft Lists
- Mixpanel
- MongoDB
- MySQL
- NetSuite SuiteAnalytics
- Optimizely
- Oracle
- Oracle Fusion Cloud Applications
- Outbrain
- Outreach
- Pardot
- Pendo
- Pinterest Ads
- Pipedrive
- Postgres
- Qualtrics
- QuickBooks
- ReCharge
- Recurly
- Sage Intacct
- Sailthru
- Salesforce
- Salesforce Marketing Cloud
- SAP Business ByDesign
- SAP Concur
- SAP HANA
- SAP S/4
- Segment
- SendGrid
- ServiceNow
- SFTP
- SharePoint
- Shopify
- Snapchat Ads
- Snowplow
- Splunk
- SQL Server
- Square
- Stripe
- SurveyMonkey
- Taboola
- The Trade Desk
- TikTok Ads
- Twilio
- Twitter Organic
- Twitter Ads
- Typeform
- UserVoice
- Verizon Media
- Webhooks
- Workday
- Workday HCM
- Xero
- YouTube Analytics
- Zendesk Chat
- Zendesk Sell
- Zendesk Sunshine
- Zendesk Support
- Zoho CRM
- Zuora
- Zuora Sandbox
Adjustlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adjust",
"group_id": "target_group_id",
"config": {
"schema": "adjust"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
csv_definition
,export_storage_type
,bucket_name
, ands3_role_arn
(optional) in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "adjust", "group_id": "target_group_id", "config": { "schema": "adjust" }, "auth": { "csv_definition" : "my export definition", "export_storage_type" : "AWS_S3 or GCS", "bucket_name": "bucket", "s3_role_arn" : "role_arn" } }
Auth parameters
Name Description Possible Values csv_definition
CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition). export_storage_type
Your cloud storage. GCS
,AWS_S3
bucket_name
Your AWS S3 or GCS bucket. s3_role_arn
Used if the export_storage_type
isAWS_S3
, the Role ARN required for authentication.NOTE: If
export_storage_type
isGCS
is, then you will need to grant Fivetran access to your Google Cloud Storage bucket. -
By using the Connect Card or the Fivetran dashboard.
Adobe Analyticslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics",
"client_id": "clientId",
"client_secret": "clientSecret",
"technical_account_id": "technicalAccountId",
"organization_id": "organizationId",
"private_key": "privateKey",
"date_granularity": "HOUR",
"timeframe_months": "THREE",
"adobe_analytics_configurations": [
{
"table": "test_table",
"sync_mode": "SpecificReportSuites",
"report_suites": [
"test_report_suites"
],
"elements": [
"variables/daterangeweek"
],
"metrics": [
"metrics/videoplay"
],
"calculated_metrics": [
"cm300009702_5f3af08b41e485452a641b88"
],
"segments": [
"s300009702_5f3a8781f882e4754a131377"
]
}
]
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
client_id |
Client ID from the Service Account (JWT) credentials of your Adobe Project. | |
client_secret |
Client Secret from the Service Account (JWT) credentials of your Adobe Project. | |
technical_account_id |
Technical Account ID from the Service Account (JWT) credentials of your Adobe Project. | |
organization_id |
Organization ID from the Service Account (JWT) credentials of your Adobe Project. | |
private_key |
The complete contents of your private key file including the start and end tags (----BEGIN PRIVATE KEY---- Your key without line breakers----END PRIVATE KEY---- ). |
|
date_granularity |
The aggregation duration. Default value: HOUR . |
HOUR , DAY , MONTH , QUARTER , YEAR |
timeframe_months |
The number of months’ worth of reporting data to include in the initial sync. This cannot be modified once the connector is created. Default value: TWELVE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
adobe_analytics_configurations |
The list of configurations of tables you want to sync. The number of tables and their configurations is limited to 5. Required for connector creation. | |
table |
The table name unique within the schema to which connector will sync the data. Required for connector creation. | |
sync_mode |
Whether to sync all report suites or specific report suites. Default value: AllReportSuites . |
AllReportSuites , SpecificReportSuites |
report_suites |
Specific report suites to sync. Must be populated if sync_mode is set to SpecificReportSuites . |
|
elements |
The elements that you want to sync. | |
metrics |
The metrics that you want to sync. | |
calculated_metrics |
The calculated_metrics that you want to sync. | |
segments |
The segments that you want to sync. |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Adobe Analytics Data Feedlink
The Adobe Analytics Data Feed connector supports the following cloud file storage services as a source:
The API requests are source-specific.
Amazon S3 Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics_data_feed",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics_data_feed_s3",
"source": "S3",
"s3bucket": "bucket",
"s3role_arn": "role_arn"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
s3bucket |
The S3 bucket name. |
s3role_arn |
The Role ARN required for authentication. |
source |
The data source. |
Amazon S3 Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
s3bucket
,s3role_arn
andsource
. - By using the Connect Card or the Fivetran dashboard.
Azure Blob Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics_data_feed",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics_data_feed_blob",
"source": "AZURE_BLOB_STORAGE",
"abs_connection_string": "connection_string",
"abs_container_name": "container_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
abs_connection_string |
Azure blob storage connection string. |
abs_container_name |
Azure blob storage container name. |
source |
The data source. |
Azure Blob Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
abs_connection_string
,abs_container_name
andsource
. - By using the Connect Card or the Fivetran dashboard.
FTP(S) Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics_data_feed",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics_data_feed_ftp",
"source": "FTP",
"ftp_host": "host",
"ftp_port": 21,
"ftp_user": "user",
"ftp_password": "password",
"is_ftps": true
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
ftp_host |
FTP host. | |
ftp_port |
FTP port. | |
ftp_user |
FTP user. | |
ftp_password |
FTP password. | |
is_ftps |
Use Secure FTP (FTPS). | Specify true for FTPS, false for FTP |
source |
The data source. |
FTP(S) Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
ftp_host
,ftp_port
,ftp_user
,ftp_password
andsource
. - By using the Connect Card or the Fivetran dashboard.
SFTP Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adobe_analytics_data_feed",
"group_id": "target_group_id",
"config": {
"schema": "adobe_analytics_data_feed_sftp",
"source": "SFTP",
"sftp_host": "host",
"sftp_port": 22,
"sftp_user": "user",
"sftp_password": "password",
"sftp_is_key_pair": true
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sftp_host |
SFTP host. | |
sftp_port |
SFTP port. | |
sftp_user |
SFTP user. | |
sftp_password |
SFTP password required if sftp_is_key_pair is false | |
sftp_is_key_pair |
Log in with key pair or password | true , false |
source |
The data source. |
SFTP Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sftp_host
,sftp_port
,sftp_user
,sftp_password
andsource
. - By using the Connect Card or the Fivetran dashboard.
ADP Workforce Now Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "adp_workforce_now",
"group_id": "target_group_id",
"config": {
"schema": "test_adp_workforce_now",
"client_id": "test_client_id",
"client_secret": "test_client_secret",
"ws_certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
"private_key": "xxxxx-xxxxx-xxxxx-xxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id |
Your ADP Client ID. |
client_secret |
Your ADP Client Secret. |
ws_certificate |
The contents of your PEM formatted Web Services certificate file. |
private_key |
The contents of your private key file. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
client_id
,client_secret
,ws_certificate
andprivate_key
. - By using the Connect Card or the Fivetran dashboard.
AdRolllink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service" : "adroll",
"group_id": "target_group_id",
"config": {
"schema": "adroll",
"table": "table",
"sync_mode" : "SpecificAdvertisables",
"advertisables": ["adv1","adv2"],
"report_type" : "ALL_CAMPAIGNS",
"dimensions": ["eid","campaigns"],
"metrics": ["impressions","cost"],
"timeframe_months": "THREE"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
sync_mode |
Whether to sync all advertisables or specific advertisables. Default value: AllAdvertisables . |
AllAdvertisables , SpecificAdvertisables |
advertisables |
Specific advertisables to sync. Must be populated if sync_mode is set to SpecificAdvertisables . |
|
report_type |
The report type you want. Default value: ALL_ADS . |
ALL_AUDIENCE , ALL_CAMPAIGNS , ALL_ADS , ALL_ADGROUPS , CONVERSIONS , ALL_ADVERTISABLES |
dimensions |
The dimenstions that you want to sync. | |
metrics |
The metrics that you want to sync. | |
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service" : "adroll", "group_id": "target_group_id", "config": { "schema": "adroll", "table": "table", "sync_mode" : "SpecificAdvertisables", "advertisables": ["adv1","adv2"], "report_type" : "ALL_CAMPAIGNS", "dimensions": ["eid","campaigns"], "metrics": ["impressions","cost"], "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your AdRoll client application.client_secret
Client Secret
of your AdRoll client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
Airtablelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "airtable",
"group_id": "target_group_id",
"config": {
"schema_prefix" : "test_airtable",
"api_key" : "****"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
api_key |
API key of the Airtable account. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
base_id
,table_name
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Amazon Ads Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "amazon_ads",
"group_id": "target_group_id",
"config": {
"schema": "test_amazon_ads",
"region": "NORTH_AMERICA",
"sync_mode": "SpecificProfiles",
"profiles": [12345],
"attribution_window": "DAY_7"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
region |
The region used by the Amazon Ads profile. | NORTH_AMERICA , EUROPE , FAR_EAST |
sync_mode |
Option to select connector should sync all profiles or specific profiles. | AllProfiles , SpecificProfiles |
profiles |
Specific User Profile IDs to sync. Must be populated if sync_mode is set to SpecificProfiles . |
|
attribution_window |
Time period used to attribute conversions based on clicks. | DAY_1 , DAY_7 , DAY_14 , DAY_30 |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "amazon_ads", "group_id": "target_group_id", "config": { "schema": "test_amazon_ads", "region": "NORTH_AMERICA", "sync_mode": "SpecificProfiles", "profiles": [12345], "attribution_window": "DAY_7" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Amazon Ads client application.client_secret
Client Secret
of your Amazon Ads client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
Amazon Kinesis Firehoselink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "kinesis",
"group_id": "target_group_id",
"config": {
"schema": "test_kinesis",
"table": "kinesis_table",
"role_arn": "arn::your_role_arn",
"bucket": "aws_region_code",
"prefix": ""
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. |
role_arn |
The Role ARN required for authentication. |
bucket |
The name of the Kinesis bucket. |
prefix |
Folder path to the Kinesis files within the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
role_arn
andbucket
. - By using the Connect Card or the Fivetran dashboard.
Amazon S3link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "s3",
"group_id": "target_group_id",
"config": {
"schema": "test_s3",
"table": "table_name",
"external_id": "group_id",
"role_arn": "arn::your_role_arn",
"bucket": "bucket_name",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
external_id |
Used for authentication along with the role_arn . If not provided, it uses connector’s group_id . Use the List All Groups endpoint to find the group_id . |
|
role_arn |
The Role ARN required for authentication. | |
bucket |
The S3 bucket name. | |
prefix |
All files and folders under this folder path will be searched for files to sync. | |
pattern |
All files in your search path matching this regular expression will be synced. | |
file_type |
If your files are saved with improper extensions, you can force them to by synced as the selected filetype. | infer , csv , json , tsv , avro |
compression |
The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error |
If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option |
If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern |
Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence |
If your CSVs use a special value indicating null, you can specify it here. | |
delimiter |
You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char |
If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before |
We will skip over the number of lines specified before syncing data. | |
skip_after |
We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
external_id
,role_arn
andbucket
. - By using the Connect Card or the Fivetran dashboard.
Amplitudelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "amplitude",
"group_id": "target_group_id",
"config": {
"schema": "test_amplitude",
"project_credentials": [
{
"project": "projectName1",
"api_key": "apiKey1",
"secret_key": "secretKey1"
},
{
"project": "projectName2",
"api_key": "apiKey2",
"secret_key": "secretKey2"
}
]
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
project |
The project name you wish to use with Fivetran. |
api_key |
The API key of the project. |
secret_key |
The secret key of the project. |
Authorizationlink
There are two ways to authorize this connector type:
- When creating by specifying the following field in the request:
projects
; - After creation using the Connect Card or the Fivetran dashboard.
Anaplanlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "anaplan",
"group_id": "target_group_id",
"config": {
"schema": "test_anaplan",
"auth_mode": "basic",
"username": "username",
"password": "password",
"certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
"private_key": "your_api_secret",
"sync_mode": "SpecificExports",
"selected_exports": [ "8a81b00f68d4b4c50168dc49db4520d4_4CCDDEC7E28C4D3CA4212986182B8EB1_116000000000" ]
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
auth_mode |
The Anaplan authentication method. | Basic , Certificate |
username |
Your Anaplan user ID. Must be populated if auth_mode is set to Basic . |
|
password |
Your Anaplan password. Must be populated if auth_mode is set to Basic . |
|
certificate |
The contents of your PEM certificate file. Must be populated if auth_mode is set to Certificate . |
|
private_key |
The contents of your private key file. Must be populated if auth_mode is set to Certificate . |
|
sync_mode |
Whether to sync all exports or specific exports. | AllExports , SpecificExports |
selected_exports |
The list of export IDs in the format <workspace_id>_<model_id>_<export_id> that the connector will sync. Must be populated if sync_mode is set to SpecificExports . |
Authorizationlink
There are two ways to authorize this connector type:
-
When creating, depending on the
auth-mode
:- If
Basic
, by specifyingusername
andpassword
fields. - If
Certificate
, by specifyingcertificate
andprivate_key
fields.
- If
-
After creation using the Connect Card or the Fivetran dashboard.
Apache Kafkalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "apache_kafka",
"group_id": "target_group_id",
"config": {
"schema": "test_apache_kafka",
"consumer_group": "consumer_group",
"servers": "serveraddress1:8080, serveraddress2:8080",
"message_type": "Json",
"sync_type": "Packed",
"security_protocol": "SSL"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
consumer_group |
Kafka consumer group name. | |
servers |
Comma-separated list of Kafka servers in the format server:port . |
|
message_type |
Kafka message type. | Json , Text |
sync_type |
Kafka sync type. Unpacked messages must be valid JSON. | Unpacked , Packed |
security_protocol |
Security protocol for Kafka interaction. | PLAINTEXT , SSL |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
consumer_group
andservers
. - By using the Connect Card or the Fivetran dashboard.
Apple App Storelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "itunes_connect",
"group_id": "target_group_id",
"config": {
"schema": "itunes_connect",
"username": "user",
"password": "password",
"app_specific_password": "your_app_specific_password",
"apps": ["iTunes_app"],
"sales_accounts": ["iTunes_sales_account"],
"finance_accounts": ["iTunes_finance_account"],
"app_sync_mode" : "SpecificApps",
"sales_account_sync_mode": "SpecificSalesAccounts",
"finance_account_sync_mode": "SpecificFinanceAccounts",
"timeframe_months": "THREE"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
username |
Your Apple ID | |
password |
Your password | |
app_specific_password |
Your app-specific password | |
apps |
Specific apps to sync. Must be populated if app_sync_mode is set to SpecificApps . |
|
sales_accounts |
Specific sales account to sync. Must be populated if sales_account_sync_mode is set to SpecificSalesAccounts . |
|
finance_accounts |
Specific finance accounts to sync. Must be populated if finance_account_sync_mode is set to SpecificFinanceAccounts . |
|
app_sync_mode |
Whether to sync all apps or specific apps. | AllApps , SpecificApps |
sales_account_sync_mode |
Whether to sync all sales accounts or specific sales accounts. | AllSalesAccounts , SpecificSalesAccounts |
finance_account_sync_mode |
Whether to sync all finance accounts or specific finance accounts. | AllFinanceAccounts , SpecificFinanceAccounts |
timeframe_months |
Historical sync timeframe in months. | THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Apple Search Adslink
The following example allows you to create a new connector without authorization. If you want to authorize your connector during its creation, use one of the possible authorization methods in the Authorization section.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "apple_search_ads",
"group_id": "target_group_id",
"config": {
"schema" : "apple_search_ads"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
is_auth2_enabled |
The contents of your PEM certificate file. Default value: false |
true , false |
pem_certificate |
The contents of your PEM certificate file. Must be populated if is_auth2_enabled is set to false . |
|
private_key |
The contents of your secret key file. Must be populated if is_auth2_enabled is set to false . |
|
client_id |
Apple Search Ads REST API Client ID. Must be populated if is_auth2_enabled is set to true . |
|
team_id |
Apple Search Ads REST API Team ID. Must be populated if is_auth2_enabled is set to true . |
|
key_id |
Apple Search Ads REST API Key ID. Must be populated if is_auth2_enabled is set to true . |
|
pem_private_key |
The contents of your PEM secret key file. Must be populated if is_auth2_enabled is set to true . |
Authorizationlink
There are three ways to authorize this connector type:
-
By specifying the
pem_certificate
andprivate_key
fields in the request.POST https://api.fivetran.com/v1/connectors
{ "service": "apple_search_ads", "group_id": "target_group_id", "config": { "schema": "apple_search_ads", "pem_certificate": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "private_key": "your_api_secret" } }
-
By specifying
is_auth2_enabled
astrue
and specifying the following fieldsclient_id
,team_id
,key_id
andpem_private_key
.POST https://api.fivetran.com/v1/connectors
{ "service": "apple_search_ads", "group_id": "target_group_id", "config": { "schema": "apple_search_ads", "is_auth2_enabled": true, "pem_private_key": "your_api_secret", "client_id": "your_api_client_id", "team_id": "your_api_team_id", "key_id": "your_api_key_id" } }
-
By using the Connect Card or the Fivetran dashboard.
AppsFlyerlink
Requestlink
POST https://api.fivetran.com/v1/connectors
Sync using webhooks and Data Lockerlink
{
"service": "appsflyer",
"group_id": "target_group_id",
"config": {
"schema": "test_appsflyer",
"access_key_id": "your_access_key_id",
"secret_key": "your_secret_key",
"home_folder": "your_home_folder"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_key_id |
Your AWS access key ID. |
secret_key |
Your AWS secret key. |
home_folder |
Your S3 home folder path of the Data Locker. |
Sync using only webhookslink
{
"service": "appsflyer",
"group_id": "target_group_id",
"config": {
"schema": "test_appsflyer",
"sync_data_locker": false
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
sync_data_locker |
Select false to sync AppsFlyer data using only webhooks. |
Authorizationlink
There are three ways to authorize this connector type:
- By specifying the following fields in the request:
access_key_id
,secret_key
, andhome_folder
, if you are connecting using webhooks and Data Locker. - By specifying the field
sync_data_locker
asfalse
, if you are connecting using only webhooks. - By using the Connect Card or the Fivetran dashboard.
Asanalink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "asana",
"group_id": "target_group_id",
"config": {
"schema": "test_asana",
"sync_mode": "SpecificProjects",
"projects": ["12345678", "23456789"]
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all projects or specific projects. | AllProjects , SpecificProjects |
projects |
Specific Project IDs to sync. Must be populated if syncMode is set to SpecificProjects . |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "asana", "group_id": "target_group_id", "config": { "schema": "test_asana", "sync_mode": "SpecificProjects", "projects": ["12345678", "23456789"] }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Asana client application.client_secret
Client Secret
of your Asana client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
AWS CloudTraillink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_cloudtrail",
"group_id": "1k56c2c4xlti6",
"config": {
"schema": "aws_cloudtrail_1",
"external_id": "1k56c2c4xlti6",
"bucket" : "fivetran-cloudtrail",
"role_arn": "arn:aws:iam::***********",
"prefix" : "test_prefix"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
external_id |
This is the same as your group_id , used for authentication along with the role_arn . |
role_arn |
The Role ARN required for authentication. |
bucket |
The AWS bucket name which is configured for AWS CloudTrail. |
prefix |
If prefix is present when configuring the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
external_id
,role_arn
andbucket
. - By using the Connect Card or the Fivetran dashboard.
AWS Inventorylink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_inventory",
"group_id": "target_group_id",
"config": {
"schema": "test_aws_inventory",
"bucket" : "fivetran-config",
"role_arn": "arn:aws:iam::***********",
"prefix" : "test_prefix"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
role_arn |
The Role ARN required for authentication. |
bucket |
The AWS bucket name that is configured for AWS Config. |
prefix |
The prefix if you used one when configuring the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
role_arn
andbucket
. - By using the Connect Card or the Fivetran dashboard.
AWS Lambdalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_lambda",
"group_id": "target_group_id",
"config": {
"schema": "test_lambda",
"function": "function_name",
"role_arn": "arn::your_role_arn",
"region": "aws_region_code",
"secrets": "{'secret1':'xxxxxxx', 'secret2':'xxxxxxx'}"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
function |
The name of your AWS Lambda Function. |
role_arn |
The Role ARN required for authentication. |
region |
The AWS region code for the DynamoDB instance, e.g. us-east-1 . |
secrets |
The secrets that should be passed to the function at runtime. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
function
,function
,role_arn
andsecrets
. - By using the Connect Card or the Fivetran dashboard.
AWS MSK Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "aws_msk",
"group_id": "target_group_id",
"config": {
"schema": "test_msk",
"consumer_group": "consumer_group",
"servers": "serveraddress1:8080, serveraddress2:8080",
"message_type": "Json",
"sync_type": "Packed",
"security_protocol": "SSL",
"saslScram512Key": "sasl_key",
"saslScram512Secret": "sasl_secret",
"trusted_cert": "test_trusted_cert",
"client_cert": "test_client_cert",
"client_cert_key": "test_client_key"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
consumer_group |
The name of consumer group created for Fivetran. | |
servers |
Comma-separated list of Kafka servers in the server:port format. |
|
message_type |
The Message type. | Json , Avro , Text ,Protobuf |
sync_type |
The sync type. Unpacked messages must be valid JSON. | Packed , Unpacked |
security_protocol |
The security protocol for Kafka interaction. | PLAINTEXT , TLS , SASL |
sasl_scram512_key |
If security_protocol is set to SASL , enter your secret’s saslScram512Key . |
|
sasl_scram512_secret |
If security_protocol is set to SASL , enter your secret’s saslScram512Key . |
|
trusted_cert |
If security_protocol is set to TLS , upload the Trusted Certificate . |
|
client_cert |
If security_protocol is set to TLS , upload the Client Certificate . |
|
client_cert_key |
If security_protocol is set to TLS , upload the Client Certificate Key . |
Authorizationlink
There are two ways to authorize this connector type:
-
By passing the security protocol secrets:
- If you select
TLS
, upload theTrusted Certificate
,Client Certificate
, andClient Certificate Key
files. - If you select
SASL
, enter your secret’ssaslScram512Key
andsaslScram512Secret
.
- If you select
-
By using the Connect Card or the Fivetran dashboard.
Azure Blob Storagelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_blob_storage",
"group_id": "target_group_id",
"config": {
"schema": "test_azure_blob_storage",
"table": "table_name",
"container_name": "container_name",
"connection_string": "BlobEndpoint=https://abc123.blob.core.windows.net/;TableEndpoint=https://abc123.table.core.windows.net/;SharedAccessSignature=xxxxxxxxx",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
container_name |
The name of the blob container. | |
connection_string |
The blob storage container connection string. | |
prefix |
All files and folders under this folder path will be searched for files to sync. | |
pattern |
All files in your search path matching this regular expression will be synced. | |
file_type |
If your files are saved with improper extensions, you can force them to by synced as the selected filetype. | infer , csv , json , tsv , avro |
compression |
The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error |
If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option |
If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern |
Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence |
If your CSVs use a special value indicating null, you can specify it here. | |
delimiter |
You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char |
If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before |
We will skip over the number of lines specified before syncing data. | |
skip_after |
We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
container_name
andconnection_string
. - By using the Connect Card or the Fivetran dashboard.
Azure Functionslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_function",
"group_id": "target_group_id",
"config": {
"schema": "test_azure_function",
"function_app": "function_app_name",
"function_name": "function_name",
"function_key": "function_key",
"secrets": "{'secret1':'xxxxxxx', 'secret2':'xxxxxxx'}"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
function_app |
Function app name in Azure portal. |
function_name |
Name of the function to be triggered. |
function_key |
Function key used for authorization. |
secrets |
The secrets that should be passed to the function at runtime. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
function_app
,function_name
,function_key
andsecrets
. - By using the Connect Card or the Fivetran dashboard.
Azure Event Hubs Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "azure_event_hub",
"group_id": "target_group_id",
"config": {
"schema": "test_azure_event_hub",
"consumer_group": "consumer_group",
"connection_string": "connection_string",
"message_type": "Json",
"sync_type": "Packed"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
connection_string |
Connection string of the Event Hub Namespace you want to sync. | |
consumer_group |
Name of consumer group created for Fivetran. | |
message_type |
Message type. | Json , Avro , Text ,Protobuf |
sync_type |
Sync type. Unpacked messages must be valid JSON. | Packed , Unpacked |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
connection_string
andconsumer_group
fields in the request. - By using the Connect Card or the Fivetran dashboard.
Boxlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "box",
"group_id": "target_group_id",
"config": {
"schema": "test_box",
"folder_id": "folder_id"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
folder_id |
Your Box Folder URL. |
Authorizationlink
This type of connector can only be authorised through the Connect Card or the Fivetran dashboard.
Braintreelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "braintree",
"group_id": "target_group_id",
"config": {
"schema": "test_braintree",
"public_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"private_key": "your_api_secret",
"merchant_id": "merchant_id"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
public_key |
The contents of your PEM certificate file. |
private_key |
The contents of your secret key file. |
merchant_id |
Your Braintree merchant ID. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
public_key
,private_key
andmerchant_id
. - By using the Connect Card or the Fivetran dashboard.
Branchlink
NOTE: You will need to register the Fivetran-generated webhooks URL in your Branch dashboard. See the Branch setup guide for more details.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "branch",
"group_id": "target_group_id",
"config": {
"schema": "test_branch"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
This type of connector does not require authorization and can be created using the Create a Connector endpoint.
Brazelink
Requestlink
POST https://api.fivetran.com/v1/connectors
AWS S3
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"cloud_storage_type": "AWS_S3",
"s3bucket": "your_s3_bucket",
"s3role_arn": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket",
"s3external_id": "_moonbeam",
"s3folder": "your_s3_folder"
}
}
Google Cloud Storage
{
"service": "braze",
"group_id": "target_group_id",
"config": {
"schema": "test_braze",
"api_url": "test_api_url",
"api_key": "test_api_key",
"cloud_storage_type": "GCS",
"gcs_bucket": "your_gcs_bucket",
"gcs_folder": "your_gcs_folder"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
api_url |
Your Braze API URL. | |
api_key |
Your Braze API Key. | |
cloud_storage_type |
Cloud storage type Braze Current is connected to. | AWS_S3 , GCS |
s3bucket |
Your S3 bucket required if AWS_S3 is the cloud_storage_type |
|
s3role_arn |
The Role ARN required for authentication required if AWS_S3 is the cloud_storage_type |
|
s3external_id |
This is the same as your group_id , used for authentication along with the role_arn required if AWS_S3 is the cloud_storage_type |
|
s3folder |
Your S3 folder name required if AWS_S3 is the cloud_storage_type |
|
gcs_bucket |
Your GCS bucket. Required if GCS is the cloud_storage_type |
|
gcs_folder |
Your GCS folder name. Required if GCS is the cloud_storage_type |
NOTE: If
GCS
cloud storage type is being used, then you will need to grant Fivetran access to your Google Cloud Storage bucket.
Authorizationlink
There are three ways to authorize this connector type:
- By specifying the following fields in the request:
api_url
,api_key
,s3bucket
,s3role_arn
,s3external_id
ands3folder
, ifcloud_storage_type
is set toAWS_S3
. - By specifying the following fields in the request:
api_url
,api_key
,gcs_bucket
andgcs_folder
, ifcloud_storage_type
is set toGCS
. - By using the Connect Card or the Fivetran dashboard.
CloudFrontlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "cloudfront",
"group_id": "target_group_id",
"config": {
"schema": "test_cloudfront",
"external_id": "group_id",
"role_arn": "arn::your_role_arn",
"bucket": "bucket_name",
"prefix": "cloudfront_folder"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
external_id |
This is the same as your group_id , used for authentication along with the role_arn . |
role_arn |
The Role ARN required for authentication. |
bucket |
The bucket name for CloudFront. |
prefix |
The name of the CloudFront folder in the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
external_id
,role_arn
,bucket
andprefix
. - By using the Connect Card or the Fivetran dashboard.
Confluent Cloudlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "confluent_cloud",
"group_id": "target_group_id",
"config": {
"schema": "test_confluent_cloud",
"consumer_group": "consumer_group",
"servers": "serveraddress1:8080, serveraddress2:8080",
"message_type": "Json",
"sync_type": "Packed",
"security_protocol": "SASL"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
consumer_group |
Confluent Cloud consumer group name. | |
servers |
Comma-separated list of Confluent Cloud servers in the format server:port . |
|
message_type |
Confluent Cloud message type. | Json , Avro , Text |
sync_type |
Kafka sync type. Unpacked messages must be valid JSON. | Unpacked , Packed |
security_protocol |
Security protocol for Confluent Cloud interaction. | PLAINTEXT , SASL_SSL |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
consumer_group
andservers
. - By using the Connect Card or the Fivetran dashboard.
Coupalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "coupa",
"group_id": "target_group_id",
"config": {
"schema": "coupa_schema",
"instance": "instance",
"api_key": "api_key"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
instance |
The instance name of your Coupa account in the URL. |
api_key |
Your Coupa API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
instance
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Criteolink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "criteo",
"group_id": "target_group_id",
"config": {
"schema": "test_criteo",
"client_id": "xxxxx-xxxxxx-x-xxxx",
"client_secret": "your_api_secret"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id |
Your Criteo Client ID. |
client_secret |
Your Criteo client secret key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
client_id
andclient_secret
. - By using the Connect Card or the Fivetran dashboard.
Delighted In Devlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service" : "delighted",
"group_id" : "target_group_id",
"config" : {
"schema" : "test_delighted",
"api_key" : "******"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
API Key for your Delighted account |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_key
. - By using the Connect Card or the Fivetran dashboard.
Dropboxlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
The connector supports two sync strategies:
Magic Folder Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dropbox",
"group_id": "target_group_id",
"config": {
"schema": "test_dropbox",
"folder": "folder_url"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
folder |
Your Dropbox Folder URL. |
Merge Mode Requestlink
To use the Merge Mode sync strategy, specify the is_single_table_mode
parameter as true
. If you don’t specify the parameter, we will use the default Magic Folder strategy to sync files.
POST https://api.fivetran.com/v1/connectors
{
"service": "dropbox",
"group_id": "target_group_id",
"config": {
"schema": "test_dropbox",
"table": "dest_table",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"compression": "infer",
"on_error": "fail",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "|",
"escape_char": "escape_char",
"skip_before": "0",
"skip_after": "0",
"is_single_table_mode": "true"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema (required) |
The connector schema name has to be unique within the group (destination). | |
table (required) |
The table name within the schema to which the connector will sync the data. | |
prefix |
All files and folders under this folder path will be searched for files to sync. | |
pattern |
All files in your search path matching this regular expression will be synced. | |
file_type |
If your files are saved with improper extensions, you can force them to be synced as the selected filetype. | infer , csv , json , tsv , avro , parquet |
compression |
The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error |
If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option |
If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern |
Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence |
If your CSVs use a special value indicating null, you can specify it here. | |
delimiter |
You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char |
If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before |
We will skip over the number of lines specified before syncing data. | |
skip_after |
We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
is_single_table_mode (required as true ) |
Allows the creation of connector using Merge Mode strategy. | true , false |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "dropbox", "group_id": "target_group_id", "config": { "schema": "test_dropbox", "folder": "folder_url" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Dropbox client application.client_secret
Client Secret
of your Dropbox client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
DynamoDBlink
Before creating a DynamoDB connection, you must first follow the DynamoDB setup guide
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dynamodb",
"group_id": "target_group_id",
"config": {
"schema": "test_dynamodb",
"external_id": "external_id",
"role_arn": "arn::your_role_arn",
"aws_region_code": "aws_region_code"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
external_id |
This is the same as your group_id , used for authentication along with the role_arn . |
role_arn |
The Role ARN required for authentication. |
aws_region_code |
The AWS region code for the DynamoDB instance, e.g. us-east-1 . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
external_id
,role_arn
andaws_region_code
. - By using the Connect Card or the Fivetran dashboard.
Eloqualink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "eloqua",
"group_id": "target_group_id",
"config": {
"schema": "test_eloqua"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Emaillink
After configuring an Email connector, you’ll send your emails to group_id.schema.table_name@email-connector.fivetran.com
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "email",
"group_id": "target_group_id",
"config": {
"schema": "test_email",
"table": "table_name",
"pattern": "file_pattern",
"file_type": "infer",
"compression": "infer",
"on_error": "skip",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
pattern |
All files in your search path matching this regular expression will be synced. | |
file_type |
If your files are saved with improper extensions, you can force them to by synced as the selected filetype. | infer , csv , json , tsv , avro |
compression |
The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error |
If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
archive_pattern |
Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence |
If your CSVs use a special value indicating null, you can specify it here. | |
delimiter |
You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char |
If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before |
We will skip over the number of lines specified before syncing data. | |
skip_after |
We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the required fields in the request.
- By using the Connect Card or the Fivetran dashboard.
Facebook Ad Account sunsetlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "facebook_ad_account",
"group_id": "target_group_id",
"config": {
"schema": "fb_ad_account_test",
"sync_mode": "SpecificAccounts",
"accounts": ["acc1","acc2"]
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. Default value: AllAccounts . |
AllAccounts , SpecificAccounts |
accounts |
Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts . |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Facebook Ad Insights sunsetlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "facebook",
"group_id": "group_id",
"config": {
"schema": "facebook",
"table": "facebook",
"accounts": [],
"fields": [],
"breakdowns": [],
"action_breakdowns": [],
"sync_mode": "sync_mode",
"aggregation": "aggregation",
"config_type": "config_type",
"prebuilt_report": "prebuilt_report",
"action_report_time": "impression",
"click_attribution_window": "click_attribution_window",
"view_attribution_window": "view_attribution_window",
"timeframe_months": "SIX"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
accounts |
List of accounts of which connector will sync the data. | |
fields |
List of fields which connector will sync. Possible field values. | |
breakdowns |
List of breakdowns which connector will sync. Possible breakdowns values. | |
action_breakdowns |
List of action_breakdowns which connector will sync. Possible action_breakdowns values. | |
sync_mode |
Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. | |
aggregation |
Options to select aggregation duration. Possible aggregation values. | |
config_type |
Option to select Prebuilt Reports or Custom Reports. Possible config_type values. | |
prebuilt_report |
The name of report of which connector will sync the data. Possible prebuilt_report values. | |
action_report_time |
The report time of action stats. Possible action_report time values. | |
click_attribution_window |
Time period to attribute conversions based on clicks. Possible click_attribution_window values. | |
view_attribution_window |
Time period to attribute conversions based on views. Possible view_attribution_window values. | |
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: THREE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Facebook Adslink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "facebook_ads",
"group_id": "target_group_id",
"config": {
"schema": "facebook_ads",
"sync_mode": "SpecificAccounts",
"accounts": ["act_123"],
"custom_tables": [
{
"table_name": "table_1",
"config_type": "Custom",
"fields": ["ad_id","clicks", "actions"],
"breakdowns": ["frequency_value", "device_platform"],
"action_breakdowns": ["action_type","action_device"],
"aggregation": "Week",
"action_report_time": "impression",
"click_attribution_window": "DAY_7",
"view_attribution_window": "DAY_7"
},
{
"table_name": "basic_ad_set",
"config_type": "Prebuilt",
"prebuilt_report_name": "BASIC_AD_SET"
}
],
"timeframe_months": "THREE",
"sync_metadata": "true"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Option to select connector should sync all accounts or specific accounts. Possible sync_mode values. | |
accounts |
List of accounts of which connector will sync the data. | |
custom_tables |
List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data. | |
table_name |
The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with Fivetran’s naming conventions. | |
fields |
List of fields which connector will sync. Possible field values. | |
breakdowns |
List of breakdowns which connector will sync. Possible breakdowns values. | |
action_breakdowns |
List of action_breakdowns which connector will sync. Possible action_breakdowns values. | |
aggregation |
Options to select aggregation duration. Possible aggregation values. | |
config_type |
Option to select Prebuilt Reports or Custom Reports. Possible config_type values. | |
prebuilt_report_name |
The report name to which connector will sync the data. Possible prebuilt_report values. | |
action_report_time |
The report time of action stats. Possible action_report time values. | |
click_attribution_window |
Time period to attribute conversions based on clicks. Possible click_attribution_window values. | |
view_attribution_window |
Time period to attribute conversions based on views. Possible view_attribution_window values. | |
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: THREE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
sync_metadata |
Parameter defining whether to enable or disable metadata synchronisation. Default value: TRUE . |
TRUE , FALSE |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andaccess_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "facebook_ads", "group_id": "target_group_id", "config": { "schema": "facebook_ads", "sync_mode": "SpecificAccounts", "accounts": ["act_123"], "custom_tables": [ { "table_name": "table_1", "config_type": "Custom", "fields": ["ad_id","clicks", "actions"], "breakdowns": ["frequency_value", "device_platform"], "action_breakdowns": ["action_type","action_device"], "aggregation": "Week", "action_report_time": "impression", "click_attribution_window": "DAY_7", "view_attribution_window": "DAY_7" }, { "table_name": "basic_ad_set", "config_type": "Prebuilt", "prebuilt_report_name": "BASIC_AD_SET" } ], "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }
Auth parameters
Name Description client_id
Client ID
of your Facebook client application.client_secret
Client Secret
of your Facebook client application.access_token
The long-lived Access token
along with theclient_id
andclient_secret
parameters carry the information necessary to query the Facebook Ads API -
By using the Connect Card or through the Fivetran dashboard.
Facebook Pageslink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "facebook_pages",
"group_id": "target_group_id",
"config": {
"schema": "facebook_pages",
"sync_mode" : "SpecificPages",
"pages" : ["page1","page2"]
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. Default value: AllPages . |
AllPages , SpecificPages |
pages |
Specific pages to sync. Must be populated if sync_mode is set to SpecificPages . |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andaccess_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "facebook_pages", "group_id": "target_group_id", "config": { "schema": "facebook_pages", "sync_mode" : "SpecificPages", "pages" : ["page1","page2"] }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }
Auth parameters
Name Description client_id
Client ID
of your Facebook client application.client_secret
Client Secret
of your Facebook client application.access_token
The Access Token
carries the information necessary for API resources to fetch data -
By using the Connect Card or through the Fivetran dashboard.
Financial Force Betalink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "financial_force",
"group_id": "target_group_id",
"config": {
"schema": "financial_force",
"base_url": "https://base_url.salesforce.com"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
base_url |
(Optional) The custom Salesforce domain. Make sure that the base_url starts with https:// . |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "financial_force", "group_id": "target_group_id", "config": { "schema": "financial_force", "base_url": "https://base_url.salesforce.com" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Salesforce client application.client_secret
Client Secret
of your Salesforce client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Fivetran Log Connectorlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "fivetran_log",
"group_id": "target_group_id",
"config": {
"schema": "fivetran_log_schema",
"group" : "group_name",
"is_account_level_connector": true
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
group |
(Optional) The group name of the target_group_id . |
|
is_account_level_connector |
(Optional) Retrieve account-level logs. | true , false |
Authorizationlink
To authorize this connector, we reuse the access rights that you use to access the API.
Freshdesklink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "freshdesk",
"group_id": "target_group_id",
"config": {
"schema": "freshdesk",
"subdomain": "company_name",
"api_key": "your_api_key"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
subdomain |
Your company’s freshdesk subdomain (usually company.freshdesk.com). |
api_key |
Your Freshdesk API Key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
subdomain
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Frontlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "front",
"group_id": "target_group_id",
"config": {
"schema": "front"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "front", "group_id": "target_group_id", "config": { "schema": "front" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Front client application.client_secret
Client Secret
of your Front client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
FTPlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "ftp",
"group_id": "target_group_id",
"config": {
"schema": "test_ftp",
"table": "table_name",
"host": "ftp.company.com",
"port": "21",
"user": "user_name",
"password": "password",
"is_secure": "false",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
host |
FTP host address. | |
port |
FTP port. | |
user |
FTP user. | |
password |
FTP password. | |
is_secure |
Whether the server supports FTPS. | true , false |
prefix |
All files and folders under this folder path will be searched for files to sync. | |
pattern |
All files in your search path matching this regular expression will be synced. | |
file_type |
If your files are saved with improper extensions, you can force them to by synced as the selected filetype. | infer , csv , json , tsv , avro |
compression |
The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error |
If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option |
If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern |
Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence |
If your CSVs use a special value indicating null, you can specify it here. | |
delimiter |
You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char |
If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before |
We will skip over the number of lines specified before syncing data. | |
skip_after |
We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
user
,password
,host
andport
. - By using the Connect Card or the Fivetran dashboard.
Gainsight Customer Success Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gainsight_customer_success",
"group_id": "target_group_id",
"config": {
"schema": "testing_gainsight",
"sub_domain": "test_sub_domain",
"access_key": "test_access_key"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain |
The subdomain of your Gainsight account. |
access_key |
The access key for API authentication. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying the following fields in the request:
sub_domain
andaccess_key
. -
By using the Connect Card or through the Fivetran dashboard.
GitHublink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "github",
"group_id": "target_group_id",
"config": {
"schema": "test_github",
"sync_mode": "SpecificRepositories",
"repositories": ["12345678", "23456789"],
"use_webhooks": false
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all repositories or specific repositories. | AllRepositories , SpecificRepositories |
repositories |
Specific Repository IDs to sync. Must be populated if syncMode is set to SpecificRepositories . |
|
use_webhooks |
Whether to use webhook payloads from GitHub to perform incremental updates. | true , false |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying username, pat and auth_mode in the auth section.
POST https://api.fivetran.com/v1/connectors
{ "service": "github", "group_id": "target_group_id", "config": { "schema": "test_github", "sync_mode": "SpecificRepositories", "repositories": ["12345678", "23456789"], "use_webhooks": false, "username": "github-login", "pat": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "auth_mode": "PersonalAccessToken" } }
Auth parameters
Name Description username
Login
of your GitHub profile.pat
The Personal Access Token
generated in Github.auth_mode
Authorization type. -
By using the Connect Card or through the Fivetran dashboard.
Google Ad Managerlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "double_click_publishers",
"group_id": "target_group_id",
"config": {
"schema": "test_google_ad_manager",
"table": "test_table",
"dimensions": ["DATE", "LINE_ITEM_ID", "LINE_ITEM_NAME"],
"dimension_attributes": ["LINE_ITEM_PRIORITY"],
"columns": ["TOTAL_LINE_ITEM_LEVEL_CLICKS"],
"network_code": "0"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
dimensions |
Report dimensions to include in the sync. The date dimension is mandatory for all the report types. |
See Ad Manager dimensions documentation |
dimension_attributes |
Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions. | See Ad Manager dimension attributes documentation |
columns |
Columns provide all trafficking statistics and revenue information available for the chosen Dimensions. | See Ad Manager column documentation |
network_code |
Network code is a unique, numeric identifier for your Ad Manager network. | See Find Ad Manager account information |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "double_click_publishers", "group_id": "target_group_id", "config": { "schema": "test_google_ad_manager", "table": "test_table", "dimensions": ["DATE", "LINE_ITEM_ID", "LINE_ITEM_NAME"], "dimension_attributes": ["LINE_ITEM_PRIORITY"], "columns": ["TOTAL_LINE_ITEM_LEVEL_CLICKS"], "network_code": "0" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Google Ad Manager client application.client_secret
Client Secret
of your Google Ad Manager client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Ads In Devlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_ads",
"group_id": "target_group_id",
"config": {
"schema": "google_ads",
"customer_id": "xxx-xxx-xxxx",
"sync_mode": "SpecificAccounts",
"timeframe_months": "SIX",
"accounts": [],
"manager_accounts": [],
"reports": [
{
"table": "table_1",
"report_type": "customer",
"fields": [ "segments.date", "customer.id", "segments.ad_network_type", "segments.device", "metrics.clicks", "metrics.cost_micros" ]
},
{
"table": "table_2",
"report_type": "campaign",
"fields": [ "segments.date", "campaign.id", "customer.id", "segments.click_type", "segments.ad_network_type", "metrics.clicks", "metrics.impressions" ]
}
],
"conversion_window_size": 30
}
}
Config parameters
Name | Description | Supported Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
customer_id |
ID of the customer, can be retrieved from your Google Ads dashboard. | |
sync_mode |
Whether to sync all accounts or specific accounts. | AllAccounts , SpecificAccounts , ManagerAccounts |
timeframe_months |
The number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
accounts |
The list of Account IDs to sync. Must be populated if sync_mode is set to SpecificAccounts . |
|
manager_accounts |
The list of the Manager Account IDs whose clients will be synced. Must be populated if sync_mode is set to ManagerAccounts . |
|
reports |
The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. | |
table |
The table name within the schema to which connector will sync the data of the specific report. | |
report_type |
The name of the Google Ads report from which the connector will sync the data. You can use all report_type values that support segmenting by date as report types. |
|
fields |
A list of the fields to sync. | |
conversion_window_size |
A period of time in days during which a conversion is recorded. | From 1 to 90 days, or 0 for automatic detection. |
NOTE: The
segments.date
field is required for incremental syncs. Make sure thesegments.date
field is present for every table.
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_ads", "group_id": "target_group_id", "config": { "schema": "google_ads", "customer_id": "xxx-xxx-xxxx", "sync_mode": "SpecificAccounts", "accounts": [], "manager_accounts": [], "reports": [ { "table": "table_1", "report_type": "customer", "fields": [ "segments.date", "customer.id", "segments.ad_network_type", "segments.device", "metrics.clicks", "metrics.cost_micros" ] }, { "table": "table_2", "report_type": "campaign", "fields": [ "segments.date", "campaign.id", "customer.id", "segments.click_type", "segments.ad_network_type", "metrics.clicks", "metrics.impressions" ] } ], "conversion_window_size": 30 }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret", "user_agent": "my_company_name", "developer_token": "my_developer_token" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Google Ads client application.client_secret
Client Secret
of your Google Ads client application.user_agent
Your company’s name in your Google Ads client application. developer_token
Your approved Developer token
to connect to the Google Ads API.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Analyticslink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics",
"sync_mode": "SpecificAccounts",
"accounts": ["0123456789"],
"profiles": ["0123456789", "9876543210"],
"reports": [
{
"table": "table_1",
"config_type": "Custom",
"dimensions": ["date", "dimension1", "pagePath", "browser"],
"metrics": ["pageviews", "sessions", "timeOnPage", "users"],
"segments": ["Bounced Sessions", "Direct Traffic"],
"filter": "ga:browser==Chrome"
},
{
"table": "table_2",
"config_type": "Prebuilt",
"prebuilt_report": "CHANNEL_TRAFFIC"
}
],
"timeframe_months": "SIX"
}
}
Legacy Requestlink
The following request is deprecated and will be removed in the future:
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics",
"table": "test_table",
"sync_mode": "SpecificAccounts",
"accounts": ["0123456789"],
"profiles": ["0123456789", "9876543210"],
"config_type": "Custom",
"dimensions": ["date", "dimension1", "pagePath", "browser"],
"metrics": ["pageviews", "sessions", "timeOnPage", "users"],
"segments": ["Bounced Sessions", "Direct Traffic"],
"filter": "ga:browser==Chrome",
"timeframe_months": "SIX"
}
}
Config parameters
Name | Description | Supported Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. | AllAccounts , SpecificAccounts |
accounts |
The list of specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts . |
|
profiles |
Specific User Profile IDs to sync. Must be populated if syncMode is set to SpecificAccounts . |
|
reports |
The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. | |
table |
The table name within the schema to which connector will sync the data of the specific report. | |
config_type |
Whether to use the Prebuilt Reports or Custom Reports. | Prebuilt , Custom |
prebuilt_report |
The name of the Prebuilt Report from which the connector will sync the data. | See the list of supported prebuilt_reports. |
dimensions |
The report dimensions to include into a sync. The date dimension is mandatory for all the report types. |
See Google Analytics Dimensions & Metrics Explorer |
metrics |
The report metrics to include into a sync. | See Google Analytics Dimensions & Metrics Explorer |
segments |
A segment is a subset of your Analytics data that is made up of one or more non-destructive filters (filters that do not alter the underlying data). Those filters isolate subsets of users, sessions, and hits. | See Google Analytics Dimensions & Metrics Explorer |
filter |
String parameter restricts the data returned for your report. To use the filters parameter, specify a dimension or metric on which to filter, followed by the filter expression | See Google Analytics Core Reporting API |
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once connection is created. The default value: TWELVE . |
THREE , SIX , TWELVE , TWENTY_FOUR and ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_analytics", "group_id": "target_group_id", "config": { "schema": "test_google_analytics", "sync_mode": "SpecificAccounts", "accounts": ["0123456789"], "profiles": ["0123456789", "9876543210"], "reports": [ { "table": "table_1", "config_type": "Custom", "dimensions": ["date", "dimension1", "pagePath", "browser"], "metrics": ["pageviews", "sessions", "timeOnPage", "users"], "segments": ["Bounced Sessions", "Direct Traffic"], "filter": "ga:browser==Chrome" }, { "table": "table_2", "config_type": "Prebuilt", "prebuilt_report": "CHANNEL_TRAFFIC" } ], "timeframe_months": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Google Analytics client application.client_secret
Client Secret
of your Google Analytics client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Analytics 4 Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics_4",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics",
"timeframe_months": "SIX",
"sync_mode": "SPECIFIC_ACCOUNTS",
"accounts": ["0123456789"],
"properties": ["0123456789", "9876543210"],
"reports": [
{
"table": "table_1",
"config_type": "CUSTOM",
"dimensions": ["date", "firstUserMedium"],
"metrics": ["newUsers", "totalRevenue", "sessions"],
"filter_field_name": "browser",
"filter_field_value": "chrome"
},
{
"table": "table_2",
"config_type": "PREBUILT",
"prebuilt_report": "USER_ACQUISITION_FIRST_USER_MEDIUM_REPORT"
}
]
}
}
Config parameters
Name | Description | Supported Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. | ALL_ACCOUNTS , SPECIFIC_ACCOUNTS |
accounts |
The list of specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS . |
|
properties |
The list of specific Google Analytics 4 property IDs. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS . |
|
reports |
The list of reports. Each report corresponds to a table within the schema to which connector will sync the data. | |
table |
The table name within the schema to which connector will sync the data of the specific report. | |
config_type |
Whether to use the Prebuilt Reports or Custom Reports. | PREBUILT , CUSTOM |
prebuilt_report |
The name of the Prebuilt Report from which the connector will sync the data. | See the list of supported prebuilt_reports. |
dimensions |
The report dimensions to include into a sync. | See Google Analytics APIs Explorer |
metrics |
The report metrics to include into a sync. | See Google Analytics APIs Explorer |
filter_field_name |
The dimension name to filter on. | |
filter_field_value |
The dimension value to filter on. It is case-insensitive. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_analytics_4", "group_id": "target_group_id", "config": { "schema": "test_google_analytics", "timeframe_months": "SIX", "sync_mode": "SPECIFIC_ACCOUNTS", "accounts": ["0123456789"], "properties": ["0123456789", "9876543210"], "reports": [ { "table": "table_1", "config_type": "CUSTOM", "dimensions": ["date", "firstUserMedium"], "metrics": ["newUsers", "totalRevenue", "sessions"], "filter_field_name": "browser", "filter_field_value": "chrome" }, { "table": "table_2", "config_type": "PREBUILT", "prebuilt_report": "USER_ACQUISITION_FIRST_USER_MEDIUM_REPORT" } ], "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } } }
Auth parameters
Name Description client_id
Client ID
of your Google Analytics client application.client_secret
Client Secret
of your Google Analytics client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Analytics 4 Export Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics_4_export",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics_4_export",
"project_id": "test_project_id",
"dataset_id": "test_dataset_id",
"bucket_name": "test_bucket_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
project_id |
The Project ID. |
dataset_id |
The Dataset ID. |
bucket_name |
The name of the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
project_id
,dataset_id
, andbucket_name
. - By using the Connect Card or the Fivetran dashboard.
Initial Configurationlink
To provide Fivetran access perform the following steps:
- Add the email address in the format
g-[group-id]@fivetran-production.iam.gserviceaccount.com
as a new member, where[group_id]
is the connector’s group ID. - Assign the following roles:
BigQuery Data Viewer
for DatasetId,Storage Object Admin
for BucketName, andBigQuery Job User
for Project.
Google Analytics 360link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics_360",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics_360",
"project_id": "test_project_id",
"dataset_id": "test_dataset_id",
"bucket_name": "test_bucket_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
project_id |
The project ID. |
dataset_id |
The dataset ID. |
bucket_name |
The name of the bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
project_id
,dataset_id
andbucket_name
. - By using the Connect Card or the Fivetran dashboard.
Initial Configurationlink
To provide Fivetran access perform the following steps:
- Add the email address in the format
g-[group-id]@fivetran-production.iam.gserviceaccount.com
as a new member, where [group_id] is the connector’s group ID. - Assign
BigQuery Data Viewer
,BigQuery Job User
, andBigQuery User
roles.
Google Analytics (MCF) Betalink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_analytics_mcf",
"group_id": "target_group_id",
"config": {
"schema": "test_google_analytics_mcf",
"sync_mode": "SPECIFIC_ACCOUNTS",
"accounts": ["0123456789"],
"profiles": ["0123456789", "9876543210"],
"timeframe_months": "SIX"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. Default value: ALL_ACCOUNTS |
ALL_ACCOUNTS , SPECIFIC_ACCOUNTS |
accounts |
Specific Account IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS . |
|
profiles |
Specific User Profile IDs to sync. Must be populated if sync_mode is set to SPECIFIC_ACCOUNTS . |
|
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . |
THREE , SIX , TWELVE , TWENTY_FOUR and ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_analytics_mcf", "group_id": "target_group_id", "config": { "schema": "test_google_analytics_mcf", "sync_mode": "SPECIFIC_ACCOUNTS", "accounts": ["0123456789"], "profiles": ["0123456789", "9876543210"], "timeframe_months": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Google Analytics client application.client_secret
Client Secret
of your Google Analytics client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Campaign Manager 360link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "double_click_campaign_manager",
"group_id": "target_group_id",
"config": {
"schema": "test_double_click_campaign_manager",
"table": "test_table",
"sync_mode": "SPECIFIC_PROFILES",
"user_profiles": ["1234567", "8901234"],
"timeframe_months": "SIX",
"report_type": "FLOODLIGHT",
"dimensions": ["date", "activity"],
"metrics": ["activeViewPercentAudibleImpressions"],
"report_configuration_ids": ["12", "34", "56"],
"enable_all_dimension_combinations": true
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
sync_mode |
Whether to sync all user profiles or specific ones. Default value: ALL_PROFILES . |
ALL_PROFILES , SPECIFIC_PROFILES |
user_profiles |
IDs of specific User Profiles to sync. Must be populated if sync_mode is set to SPECIFIC_PROFILES . |
|
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . |
THREE , SIX , TWELVE , TWENTY_FOUR and ALL_TIME |
report_type |
Type of reporting data to sync. Default value: STANDARD . |
FLOODLIGHT , REACH and STANDARD |
dimensions |
Report dimensions to include into a sync. The date dimension is mandatory for all the report types. The advertiser dimension is mandatory for REACH report type |
See Google Campaign Manager 360 documentation |
metrics |
Report metrics to include into a sync. | See Google Campaign Manager 360 documentation |
report_configuration_ids |
You can select only one Floodlight Configuration ID per account. | |
enable_all_dimension_combinations |
Whether to enable all reach dimension combinations in the report. Default value: false |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "double_click_campaign_manager", "group_id": "target_group_id", "config": { "schema": "test_double_click_campaign_manager", "table": "test_table", "sync_mode": "SPECIFIC_PROFILES", "user_profiles": ["1234567", "8901234"], "timeframe_months": "SIX", "report_type": "FLOODLIGHT", "dimensions": ["date", "activity"], "metrics": ["activeViewPercentAudibleImpressions"], "report_configuration_ids": ["12", "34", "56"], "enable_all_dimension_combinations": true }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Google Campaign Manager 360 client application.client_secret
Client Secret
of your Google Campaign Manager 360 client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Cloud Functionslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_cloud_function",
"group_id": "target_group_id",
"config": {
"schema": "test_google_cloud_function",
"function_trigger": "https://us-east1-b.projectname.cloudfunctions.net/function_name",
"secrets": "{'secret1':'xxxxxxx', 'secret2':'xxxxxxx'}"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
function_trigger |
The trigger URL of the cloud function. |
secrets |
The secrets that should be passed to the function at runtime. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
function_trigger
andsecrets
. - By using the Connect Card or the Fivetran dashboard.
Google Cloud Storagelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "gcs",
"group_id": "target_group_id",
"config": {
"schema": "test_gcs",
"table": "table_name",
"bucket": "bucket_name",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0",
"auth_type": "auth_type",
"secret_key": "secret_key"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
bucket |
The name of the GCS bucket. | |
prefix |
All files and folders under this folder path will be searched for files to sync. | |
pattern |
All files in your search path matching this regular expression will be synced. | |
file_type |
If your files are saved with improper extensions, you can force them to by synced as the selected filetype. | infer , csv , json , tsv , avro |
compression |
The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error |
If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_option |
If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern |
Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence |
If your CSVs use a special value indicating null, you can specify it here. | |
delimiter |
You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char |
If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before |
We will skip over the number of lines specified before syncing data. | |
skip_after |
We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. | |
auth_type |
Authorization type. Required for storage bucket authentication. | FIVETRAN_SERVICE_ACCOUNT , CUSTOM_SERVICE_ACCOUNT |
secret_key |
Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
bucket
,auth_type
andsecret_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Google Display & Video 360link
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_display_and_video_360",
"group_id": "target_group_id",
"config": {
"schema": "test_google_display_and_video_360",
"table": "table_name",
"config_method": "CREATE_NEW",
"partners": ["1234567", "123456789"],
"advertisers": ["1234567", "123456789"],
"report_type": "TYPE_GENERAL",
"dimensions": ["FILTER_ADVERTISER", "FILTER_DATE"],
"metrics": ["METRIC_CLICKS"],
"query_id": "123456789",
"update_config_on_each_sync": true
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
config_method |
The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is CREATE_NEW . |
CREATE_NEW , REUSE_EXISTING |
partners |
The list of partners to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW . |
|
advertisers |
The list of advertisers to include into a sync. This parameter only takes effect when config_method is set to CREATE_NEW . |
|
report_type |
The type of the report to create. This is a required parameter when config_method is set to CREATE_NEW . |
See Google Display & Video 360 Report Types |
dimensions |
The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when config_method is set to CREATE_NEW . |
See Google Display & Video 360 Dimensions |
metrics |
The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when config_method is set to CREATE_NEW . |
See Google Display & Video 360 Metrics |
query_id |
The ID of the query whose configuration you want to reuse. This is a required parameter when config_method is set to REUSE_EXISTING . |
|
update_config_on_each_sync |
Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when config_method is set to REUSE_EXISTING . The default value is true . |
true , false |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_display_and_video_360", "group_id": "target_group_id", "config": { "schema": "test_google_display_and_video_360", "table": "table_name", "config_method": "CREATE_NEW", "partners": ["1234567", "123456789"], "advertisers": ["1234567", "123456789"], "report_type": "TYPE_GENERAL", "dimensions": ["FILTER_ADVERTISER", "FILTER_DATE"], "metrics": ["METRIC_CLICKS"], "query_id": "123456789", "update_config_on_each_sync": true }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Google Display & Video 360 client application.client_secret
Client Secret
of your Google Display & Video 360 client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Drivelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_drive",
"group_id": "target_group_id",
"config": {
"schema": "test_google_drive",
"folder_id": "folder_id"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
folder_id |
Your Google Drive Folder URL. |
Authorizationlink
- The created connector can use authentication via the service account. You must share your Google Drive folder with Fivetran’s service account using the account’s auto-generated email address.The Google drive folder needs to be shared with Fivetran’s service account named g-[group_id]@fivetran-production.iam.gserviceaccount.com where [group_id] is the connector’s group ID.
- By using the Connect Card or the Fivetran dashboard.
Google Playlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_play",
"group_id": "target_group_id",
"config": {
"schema": "test_google_play",
"bucket": "bucket_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
bucket |
The Google Cloud Storage source bucket. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_play", "group_id": "target_group_id", "config": { "schema": "test_google_play", "bucket": "bucket_name" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Google Play client application.client_secret
Client Secret
of your Google Play client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Search Consolelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_search_console",
"group_id": "target_group_id",
"config": {
"schema": "test_google_search_console",
"sync_mode": "SpecificSites",
"site_urls": ["https://fivetran.com", "https://support.fivetran.com"],
"reports": [
{
"table": "search_report",
"report_type": "SEARCH_RESULTS",
"search_types": [
"WEB",
"IMAGE",
"VIDEO",
"NEWS"
],
"dimensions": [
"DATE",
"COUNTRY",
"DEVICE"
],
"aggregation": "BY_PAGE"
}
],
"timeframe_months": "SIX"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all sites or specific sites. | AllSites , SpecificSites |
site_urls |
Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites . |
|
reports |
The list of reports. Each report corresponds to a table within the schema to which connector syncs the data. | |
table |
The name of a table within the schema to which connector syncs the data of a given report. | |
report_type |
The type of report | SEARCH_RESULTS , DISCOVER , GOOGLE_NEWS |
search_types |
Search types included to sync. Supported only for the SEARCH_RESULTS report type |
WEB , IMAGE , VIDEO , NEWS |
dimensions |
The report dimensions included to sync. | DATE , COUNTRY , DEVICE , QUERY , PAGE |
aggregation |
(Optional) Aggregation type. Supported only for the SEARCH_RESULTS report type |
BY_PAGE , BY_PROPERTY |
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once connection is created. | THREE , SIX , TWELVE , TWENTY_FOUR and ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_search_console", "group_id": "target_group_id", "config": { "schema": "test_google_search_console", "sync_mode": "SpecificSites", "site_urls": ["https://fivetran.com", "https://support.fivetran.com"], "timeframe_months": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Google Search Console client application.client_secret
Client Secret
of your Google Search Console client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Google Sheetslink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "google_sheets",
"group_id": "target_group_id",
"config": {
"schema": "google_sheets",
"table": "table"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group. Required for connector creation. |
table |
The table name within the schema for which the connector will sync the data. Required for connector creation. |
Authorizationlink
There are three ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "google_sheets", "group_id": "target_group_id", "config": { "schema": "google_sheets", "table": "table", "sheet_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "named_range": "range" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Config parameters
Name Description sheet_id
The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet’s URL between /d/ and /edit. named_range
The name of the named data range on the sheet that contains the data to be synced. Auth parameters
Name Description client_id
Client ID
of your Google Sheets client application.client_secret
Client Secret
of your Google Sheets client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By specifying the values for the
sheet_id
andnamed_range
parameters in the request.POST https://api.fivetran.com/v1/connectors
{ "service": "google_sheets", "group_id": "target_group_id", "config": { "schema": "google_sheets", "table": "table", "sheet_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "named_range": "range", "auth_type": "ServiceAccount" } }
Config parameters
Name Description sheet_id
The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet’s URL between /d/ and /edit. named_range
The name of the named data range on the sheet that contains the data to be synced. auth_type
The ServiceAccount
value must be specified for this type of authorization.NOTE: The connector uses service account authentication. You must share the sheet with Fivetran’s service account named
g-[group_id]@fivetran-production.iam.gserviceaccount.com
, where[group_id]
is the connector’s group ID. -
By using the Connect Card or the Fivetran dashboard.
Greenhouselink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "greenhouse",
"group_id": "target_group_id",
"config": {
"schema": "greenhouse",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
Your Greenhouse API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Heaplink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "heap",
"group_id": "target_group_id",
"config": {
"schema": "heap",
"bucket": "http://your_test_bucket.s3.amazonaws.com",
"role_arn": "arn:aws:s3:::your_test_bucket"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
bucket |
The S3 bucket name. |
role_arn |
The Role ARN required for authentication. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
bucket
androle_arn
. - By using the Connect Card or the Fivetran dashboard.
Height Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "height",
"group_id": "target_group_id",
"config": {
"schema": "height",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
Your Height API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Help Scoutlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "helpscout",
"group_id": "target_group_id",
"config": {
"schema": "test_helpscout"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "helpscout", "group_id": "target_group_id", "config": { "schema": "test_helpscout" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Help Scout client application.client_secret
Client Secret
of your Help Scout client application.refresh_token
The long-lived refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Heroku Kafkalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "heroku_kafka",
"group_id": "target_group_id",
"config": {
"schema": "test_heroku_kafka",
"consumer_group": "consumer_group",
"servers": "serveraddress1:8080, serveraddress2:8080",
"message_type": "Json",
"sync_type": "Packed",
"security_protocol": "SSL"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
consumer_group |
Heroku Kafka consumer group name. | |
servers |
Comma-separated list of Heroku Kafka servers in the format server:port . |
|
message_type |
Heroku Kafka message type. | Json , Text |
sync_type |
Heroku Kafka sync type. Unpacked messages must be valid JSON. | Unpacked , Packed |
security_protocol |
Security protocol for Heroku Kafka interaction. | PLAINTEXT , SSL |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
consumer_group
andservers
. - By using the Connect Card or the Fivetran dashboard.
HubSpotlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "hubspot",
"group_id": "target_group_id",
"config": {
"schema": "test_hubspot"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "hubspot", "group_id": "target_group_id", "config": { "schema": "test_hubspot" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Hubspot client application.client_secret
Client Secret
of your Hubspot client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
Instagram Businesslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "instagram_business",
"group_id": "target_group_id",
"config": {
"schema": "instagram_business_test",
"sync_mode": "SpecificAccounts",
"accounts": ["123","456"],
"timeframe_months": "THREE"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. Default value: AllAccounts . |
AllAccounts , SpecificAccounts |
accounts |
Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts . |
|
timeframe_months |
Number of months of data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: SIX . |
THREE , SIX , TWELVE , TWENTY_FOUR |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andaccess_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "instagram_business", "group_id": "target_group_id", "config": { "schema": "instagram_business_test", "sync_mode" : "SpecificAccounts", "accounts" : ["123","456"], "timeframe_months" : "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }
Auth parameters
Name Description client_id
Client ID
of your Facebook client application.client_secret
Client Secret
of your Facebook client application.access_token
The Access Token
carries the information necessary for API resources to fetch data -
By using the Connect Card or through the Fivetran dashboard.
Intercomlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "intercom",
"group_id": "target_group_id",
"config": {
"schema": "test_intercom"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
access_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "intercom", "group_id": "target_group_id", "config": { "schema": "test_intercom" }, "auth": { "access_token": "my_access_token" } }
Auth parameters
Name Description access_token
The long-lived Access Token
carries the information necessary for API resources to fetch data. -
By using the Connect Card or through the Fivetran dashboard.
Iterablelink
NOTE: You will need to register the Fivetran-generated webhooks URL in your Iterable dashboard. See the Iterable setup guide for more details.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "iterable",
"group_id": "target_group_id",
"config": {
"schema": "iterable",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
Your Iterable API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Jiralink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "jira",
"group_id": "target_group_id",
"config": {
"schema": "test_jira",
"host": "mycompany.atlassian.net",
"port": 443,
"user": "user",
"password": "password",
"path": "path",
"on_premise": false
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
host |
The Jira service host address. | |
port |
The Jira service host port. | |
user |
The Jira username. | |
password |
The Jira user’s password. | |
path |
A URL subdirectory where the Jira instance is working. | |
on_premise |
Whether the Jira instance is local or in cloud. | true , false |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
andpassword
. - By using the Connect Card or the Fivetran dashboard.
Klaviyolink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "klaviyo",
"group_id": "target_group_id",
"config": {
"schema": "klaviyo",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
Your Klaviyo API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Kustomerlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "kustomer",
"group_id": "target_group_id",
"config": {
"schema": "kustomer",
"access_token": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_token |
Your Kustomer API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
access_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
Leverlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "lever",
"group_id": "target_group_id",
"config": {
"schema": "lever",
"api_key": "xxxxxxxxxxxxxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
Your Lever API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
Lightspeed Retaillink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "light_speed_retail",
"group_id": "target_group_id",
"config": {
"schema": "light_speed_retail_schema"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
LinkedIn Ad Analyticslink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "linkedin_ads",
"group_id": "target_group_id",
"config": {
"schema": "linkedin_ads",
"sync_mode": "SpecificAccounts",
"accounts": ["123","234","345"],
"view_through_attribution_window_size": "DAY_1",
"post_click_attribution_window_size" : "DAY_30"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. Default value: AllAccounts |
SpecificAccounts , AllAccounts |
accounts |
Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts . |
|
view_through_attribution_window_size |
The time period to attribute conversions based on views. Default value: DAY_7 |
DAY_1 , DAY_7 , DAY_28 , DAY_30 , DAY_90 |
post_click_attribution_window_size |
The time period to attribute conversions based on clicks. Default value: DAY_30 |
DAY_1 , DAY_7 , DAY_28 , DAY_30 , DAY_90 |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "linkedin_ads", "group_id": "target_group_id", "config": { "schema": "linkedin_ads", "sync_mode": "SpecificAccounts", "accounts": ["123","234","345"], "view_through_attribution_window_size": "DAY_1", "post_click_attribution_window_size" : "DAY_30" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your LinkedIn client application.client_secret
Client Secret
of your LinkedIn client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
LinkedIn Company Pageslink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "linkedin_company_pages",
"group_id": "target_group_id",
"config": {
"schema": "linkedin_company_pages",
"social_data_sync_timeframe": "SIX"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
social_data_sync_timeframe |
The social data (UGCPosts, Shares, Comments) sync timeframe in months. Default value: SIX . |
THREE , SIX , TWELVE |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "linkedin_company_pages", "group_id": "target_group_id", "config": { "schema": "linkedin_company_pages", "social_data_sync_timeframe": "SIX" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your LinkedIn client application.client_secret
Client Secret
of your LinkedIn client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
Mailchimplink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "mailchimp",
"group_id": "target_group_id",
"config": {
"schema": "schema_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Mandrilllink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "mandrill",
"group_id": "target_group_id",
"config": {
"schema": "mandrill",
"api_key": "xxxxxxxxxxxxxxxx",
"use_api_keys": "false",
"api_keys": "key_1, key_2, key_3"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
Your Mandrill API key. |
use_api_keys |
Whether to use multiple API keys for interaction. |
api_keys |
Comma-separated list of API keys. Required if use_api_keys is set to true . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_key
oruse_api_keys
andapi_keys
. - By using the Connect Card or the Fivetran dashboard.
MariaDBlink
Fivetran supports a few different incarnations of MariaDB.
To configure MariaDB connectors, use the MySQL instructions, with the appropriate service
name:
- Azure MariaDB -
"service": "maria_azure"
- Generic MariaDB -
"service": "maria"
- RDS -
"service": "maria_rds"
Marin Softwarelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "marin",
"group_id": "target_group_id",
"config": {
"schema": "test_marin",
"host": "marin_host_address",
"user": "marin_user",
"password": "marin_password",
"prefix": ""
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
host |
The Marin host address. |
user |
The Marin username. |
password |
The Marin user’s password. |
prefix |
Folder path to the Marin manifest file. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,user
andpassword
. - By using the Connect Card or the Fivetran dashboard.
Marketolink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "marketo",
"group_id": "target_group_id",
"config": {
"schema": "marketo",
"endpoint": "https://my.mktorest.com/rest",
"identity": "https://my.mktorest.com/identity",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"client_secret": "your_api_secret",
"api_quota": 10000
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
endpoint |
Marketo REST API endpoint. |
identity |
Marketo REST API identity url. |
client_id |
Marketo REST API Client Id. |
client_secret |
Marketo REST API Client Secret. |
api_quota |
Allowed number of API requests to Marketo instance per day, the default value is 10000. |
Check out our Marketo setup guide to configure Marketo permissions and obtain the relevant account information, including ID and secret.
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
endpoint
,identity
,client_id
,client_secret
andapi_quota
. - By using the Connect Card or the Fivetran dashboard.
Mavenlinklink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "mavenlink",
"group_id": "target_group_id",
"config": {
"schema": "mavenlink_schema"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Medallia Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "medallia",
"group_id": "target_group_id",
"config": {
"schema": "medallia_analytics",
"client_id": "clientId",
"client_secret": "clientSecret",
"subdomain": "subdomain",
"client_name": "companyName"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
client_id |
Medallia Client ID | |
client_secret |
Medallia Client Secret key | |
subdomain |
Medallia subdomain | |
client_name |
Medallia company name |
Authorizationlink
-
By specifying
client_id
,client_secret
,client_name
,subdomain
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "medallia", "group_id": "target_group_id", "config": { "schema": "test_medallia" }, "auth": { "client_id": "my_client_id", "client_secret": "my_client_secret", "subdomain": "my_subdomain", "client_name": "my_client_name" } }
-
By using the Connect Card or through the Fivetran dashboard.
Microsoft Advertisinglink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "bingads",
"group_id": "target_group_id",
"config": {
"schema": "test_bingads",
"sync_mode": "SpecificAccounts",
"accounts": ["123","234","345"],
"timeframe_months": "THREE",
"rollback_window_size": 30
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. Default value: AllAccounts . |
SpecificAccounts , AllAccounts |
accounts |
Specific accounts to sync. Must be populated if syncMode is set to SpecificAccounts . |
|
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: SIX . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
rollback_window_size |
A period of time in days during which a conversion is recorded. | 30 , 45 , 60 , 75 , or 90 days. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "bingads", "group_id": "target_group_id", "config": { "schema": "test_bingads", "sync_mode": "SpecificAccounts", "accounts": ["123","234","345"], "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Microsoft Advertising client application.client_secret
Client Secret
of your Microsoft Advertising client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
Microsoft Dynamics 365link
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dynamics_365",
"group_id": "target_group_id",
"config": {
"schema": "dynamics_365_schema",
"domain_name": "domain_name",
"resource_url": "resource_url"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
domain_name |
The custom domain name associated with Dynamics 365. |
resource_url |
The Dynamics 365 URL. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_access
andrefresh_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "dynamics_365", "group_id": "target_group_id", "config": { "schema": "dynamics_365_schema", "domain_name": "domain_name", "resource_url": "resource_url" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Dynamic 365 client application.client_secret
Client Secret
of your Dynamic 365 client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Microsoft Dynamics 365 F/Olink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "dynamics_365_fo",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_sql",
"host": "sqlinstance.mycompany.com",
"port": 1433,
"database": "sqldb",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host |
DB instance host or IP address. |
port |
The port number. |
user |
The user name. The format must be user@domain . |
password |
The user’s password. |
database |
The database name. |
tunnel_host |
SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port |
SSH port, specify only to connect via an SSH tunnel. |
tunnel_user |
SSH user, specify only to connect via an SSH tunnel. |
update_method |
The method used to detect new or changed rows. Supported values: LOGMINER - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. TELEPORT - Fivetran’s proprietary replication method that uses compressed snapshots to detect and apply changes. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,password
,user
anddatabase
. - By using the Connect Card or the Fivetran dashboard.
Microsoft Lists Betalink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "microsoft_lists",
"group_id": "target_group_id",
"config": {
"schema": "test_list",
"site_id": "target_site_id",
"site_name" : "target_site_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema has to be unique within the group (destination). Required for connector creation. |
site_id |
The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the id field in the Graph API response for sites. |
site_name |
The Name of the SharePoint site. The Site Name is the name field in the Graph API response for sites. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "microsoft_lists", "group_id": "target_group_id", "config": { "schema": "test_list", "site_id": "target_site_id", "site_name" : "target_site_name" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Microsoft client application.client_secret
Client Secret
of your Microsoft client application.refresh_token
The long-lived Refresh token carries the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Mixpanellink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "mixpanel",
"group_id": "target_group_id",
"config": {
"schema": "mixpanel",
"api_secret": "your_api_secret"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_secret |
Mixpanel API Secret. |
To find the API Secret, log in to your Mixpanel account, then click on the Account section and click on Project (see our Mixpanel setup guide). Please ensure your account has access to this information.
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_secret
field in the request. - By using the Connect Card or the Fivetran dashboard.
MongoDBlink
Fivetran supports two different MongoDB configurations. Each configuration has its own service
value:
- MongdDB Replica Set -
"service": "mongo"
- MongoDB Sharded Cluster -
"service": "mongo_sharded"
To learn more, see the setup guide for your MongoDB connector type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "mongo",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_mongo",
"hosts": ["mongoinstance.mycompany.com:27017"],
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
hosts |
A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record. |
user |
The user name. |
password |
The user’s password. |
tunnel_host |
SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port |
SSH port, specify only to connect via an SSH tunnel. |
tunnel_user |
SSH user, specify only to connect via an SSH tunnel. |
connection_type |
Possible values:Directly ,PrivateLink , SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter’s values is specified: tunnel_host , tunnel_port , tunnel_user . Otherwise, Directly is used as a value if the parameter is omitted. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
andpassword
. - By using the Connect Card or the Fivetran dashboard.
MySQLlink
Fivetran supports a few different incarnations of MySQL.
Each type of connector has its own service
value:
- Aurora MySQL -
"service": "aurora"
- Azure MySQL -
"service": "mysql_azure"
- Azure MariaDB -
"service": "maria_azure"
- Generic MariaDB -
"service": "maria"
- Generic MySQL -
"service": "mysql"
- Google Cloud MySQL -
"service": "google_cloud_mysql"
- Magento MySQL -
"service": "magento_mysql"
- Magento MySQL RDS -
"service": "magento_mysql_rds"
- MariaDB RDS -
"service": "maria_rds"
- MySQL RDS -
"service": "mysql_rds"
Check out our setup guide for your type of connector.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "mysql",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_mysql",
"host": "mysqlinstance.mycompany.com",
"port": 3306,
"database": "mysqldb",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"update_method": "BINLOG"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host |
DB instance host or IP address. |
port |
The port number. |
user |
The user name. |
password |
The user’s password. |
database |
The database name. |
tunnel_host |
SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port |
SSH port, specify only to connect via an SSH tunnel. |
tunnel_user |
SSH user, specify only to connect via an SSH tunnel. |
update_method |
The method to detect new or changed rows. Supported values: BINLOG - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. TELEPORT - Fivetran’s proprietary replication method that uses compressed snapshots to detect and apply changes. |
connection_type |
Possible values:Directly ,PrivateLink , SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter’s values is specified: tunnel_host , tunnel_port , tunnel_user . Otherwise, Directly is used as a value if the parameter is omitted. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
andpassword
. - By using the Connect Card or the Fivetran dashboard.
NetSuite SuiteAnalyticslink
Requestlink
POST https://api.fivetran.com/v1/connectors
Sync using the NetSuite.com data source
{
"service": "netsuite_suiteanalytics",
"group_id": "target_group_id",
"config": {
"schema": "test_netsuite",
"host": "netsuite_service_host",
"port": "netsuite_service_port",
"datasource": "NetSuite.com",
"account": "netsuite_account_id",
"role": "netsuite_role_id",
"email": "netsuite_email",
"password": "netsuite_password"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
host |
The NetSuite service host address. |
port |
The NetSuite service host port. |
datasource |
The NetSuite data source value: NetSuite.com . |
account |
The NetSuite Account ID. |
role |
The NetSuite Role ID for connection. |
email |
The NetSuite user’s email address. |
password |
The NetSuite user’s password. |
Sync using the NetSuite2.com data source
{
"service": "netsuite_suiteanalytics",
"group_id": "target_group_id",
"config": {
"schema": "test_netsuite",
"host": "netsuite_service_host",
"port": "netsuite_service_port",
"datasource": "NetSuite2.com",
"account": "netsuite_account_id",
"role": "netsuite_role_id",
"consumer_key": "netsuite_consumer_key",
"consumer_secret": "netsuite_consumer_secret",
"token_key": "netsuite_token_key",
"token_secret": "netsuite_token_secret"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
host |
The NetSuite service host address. |
port |
The NetSuite service host port. |
datasource |
The NetSuite2 data source value: NetSuite2.com . |
account |
The NetSuite Account ID. |
role |
The NetSuite Role ID for connection. |
consumer_key |
The NetSuite consumer key obtained when creating an Integration Record. |
consumer_secret |
The NetSuite consumer secret obtained when creating an Integration Record. |
token_key |
The NetSuite token ID obtained when creating an Access Token. |
token_secret |
The NetSuite token password obtained when creating an Access Token. |
Authorizationlink
There are three ways to authorize this connector type:
- If you use the NetSuite.com data source, by specifying the following fields in the request:
host
,port
,datasource
,account
,email
andpassword
. - If you use the NetSuite2.com data source, by specifying the following fields in the request:
host
,port
,datasource
,account
,role
,consumer_key
,consumer_secret
,token_key
andtoken_secret
. - By using the Connect Card or the Fivetran dashboard.
Optimizelylink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "optimizely",
"group_id": "target_group_id",
"config": {
"schema": "test_optimizely",
"account_id" : "test_account_id"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
account_id |
Your Optimizely account ID. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "optimizely", "group_id": "target_group_id", "config": { "schema": "test_optimizely", "account_id" : "test_account_id" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Optimizely client application.client_secret
Client Secret
of your Optimizely client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Oraclelink
Fivetran supports a few different incarnations of Oracle.
Each type of connector has its own service
value:
- Generic Oracle -
"service": "oracle"
- Oracle RAC -
"service": "oracle_rac"
- Oracle RDS -
"service": "oracle_rds"
- Oracle EBS -
"service": "oracle_ebs"
Check out our setup guide for your type of connector.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_oracle",
"host": "oracleinstance.mycompany.com",
"port": 1521,
"database": "oracledb",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host |
DB instance host or IP address. |
port |
The port number. |
user |
The user name. |
password |
The user’s password. |
database |
The database name. |
tunnel_host |
SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port |
SSH port, specify only to connect via an SSH tunnel. |
tunnel_user |
SSH user, specify only to connect via an SSH tunnel. |
connection_type |
Possible values:Directly ,PrivateLink , SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter’s values is specified: tunnel_host , tunnel_port , tunnel_user . Otherwise, Directly is used as a value if the parameter is omitted. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
,password
andpassword
. - By using the Connect Card or the Fivetran dashboard.
Oracle Fusion Cloud Applications Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "oracle_fusion_cloud_apps",
"group_id": "target_group_id",
"config": {
"schema": "test_oracle_fusion_cloud",
"server_url": "https://<oracle_fusion_cloud_instance>:<port>",
"username": "test_username",
"password": "test_password"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
server_url |
The Oracle Fusion Cloud Instance URL. |
username |
The Oracle Fusion Cloud username. |
password |
The Oracle Fusion Cloud user password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
username
andpassword
. - By using the Connect Card or the Fivetran dashboard.
Outbrainlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "outbrain",
"group_id": "target_group_id",
"config": {
"schema": "test_outbrain",
"user": "outbrain_user",
"password": "outbrain_password"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
user |
The username or email of the Outbrain user. |
password |
The Outbrain user’s password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
user
andpassword
. - By using the Connect Card or the Fivetran dashboard.
Outreachlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "outreach",
"group_id": "target_group_id",
"config": {
"schema": "test_outreach"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "outreach", "group_id": "target_group_id", "config": { "schema": "test_outreach", "domain": "domain" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Outreach client application.client_secret
Client Secret
of your Outreach client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Pardotlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "pardot",
"group_id": "target_group_id",
"config": {
"schema": "test_pardot",
"email": "pardot_user_email",
"password": "pardot_password",
"user_key": "xxxx-xxxx-xxxx",
"api_version": "",
"daily_api_call_limit": 150000,
"time_zone": "GMT+05:30"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
email |
The email of the Pardot user. |
password |
The Pardot user’s password. |
user_key |
The Pardot user’s API key. |
api_version |
Whether Fivetran should use API V3 or V4 . An empty value defaults to V3 . |
daily api call limt |
The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000. |
time zone |
The time zone configured in your Pardot instance. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
email
,password
anduser_key
. - By using the Connect Card or the Fivetran dashboard.
Pendolink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "pendo",
"group_id": "target_group_id",
"config": {
"schema": "test_pendo",
"integration_key": "pendo_integration_key",
"region": "pendo_region",
"sync_mode": "SpecificAppIds",
"app_ids": ["appId1(234)","appId2(456)"]
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
integration_key |
The integration key of the Pendo account. | |
region |
The Pendo account region. | US , EU |
sync_mode |
Whether to sync all App IDs or specific App IDs. Default value: AllAppIds . |
AllAppIds , SpecificAppIds |
app_ids |
Specific App IDs to sync. Must be populated if sync_mode is set to SpecificAppIds . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
integration_key
andregion
. - By using the Connect Card or the Fivetran dashboard.
Pinterest Adslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "pinterest_ads",
"group_id": "group_id",
"config": {
"schema": "test_pinterest",
"sync_mode": "SpecificAdvertisers",
"advertisers": ["advertiser1", "advertiser2"],
"click_attribution_window": "THIRTY",
"engagement_attribution_window": "THIRTY",
"view_attribution_window": "ONE",
"conversion_report_time": "AD_EVENT",
"timeframe_months": "THREE"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all advertisers or specific advertisers. | AllAdvertisers , SpecificAdvertisers |
advertisers |
Specific Advertisers to sync. Must be populated if sync_mode is set to SpecificAdvertisers . |
|
click_attribution_window |
The number of days to use as the conversion attribution window for a ‘click’ action. | ONE , SEVEN , THIRTY , SIXTY |
engagement_attribution_window |
The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action. | ONE , SEVEN , THIRTY , SIXTY |
view_attribution_window |
The number of days to use as the conversion attribution window for a ‘view’ action. | ONE , SEVEN , THIRTY , SIXTY |
conversion_report_time |
The date that the user interacted with the ad OR completed a conversion event. | AD_EVENT , CONVERSION_EVENT |
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: THREE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying the values of the
client_id
,client_secret
, andaccess_token
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "pinterest_ads", "group_id": "group_id", "config": { "schema": "test_pinterest", "sync_mode": "SpecificAdvertisers", "advertisers": ["advertiser1", "advertiser2"], "click_attribution_window": "THIRTY", "engagement_attribution_window": "THIRTY", "view_attribution_window": "ONE", "conversion_report_time": "AD_EVENT", "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }
Auth parameters
Name Description client_id
Client ID
of your Facebook client application.client_secret
Client Secret
of your Facebook client application.access_token
The Access Token
carries the information necessary for API resources to fetch data -
By using the Connect Card or through the Fivetran dashboard.
Pipedrivelink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "pipedrive",
"group_id": "target_group_id",
"config": {
"schema": "test_pipedrive",
"domain": "domain",
"api_token": "api_token"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
domain |
Your Pipedrive domain. |
api_token |
(Optional) The Personal API token of your Pipedrive account. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "pipedrive", "group_id": "target_group_id", "config": { "schema": "test_pipedrive", "domain": "domain" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Pipedrive client application.client_secret
Client Secret
of your Pipedrive client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Postgreslink
Fivetran supports a few different incarnations of PostgreSQL.
Each type of connector has its own service
value:
- Aurora -
"service": "aurora_postgres"
- Azure -
"service": "azure_postgres"
- Generic PostgreSQL -
"service": "postgres"
- Google Cloud SQL -
"service": "google_cloud_postgresql"
- Heroku -
"service": "heroku_postgres"
- RDS -
"service": "postgres_rds"
Check out our setup guide for your type of connector.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "postgres",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_postgres",
"host": "postgresinstance.mycompany.com",
"port": 5432,
"database": "postgres",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran",
"update_method": "WAL",
"replication_slot": "test_replication_slot"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host |
DB instance host or IP address. |
port |
The port number. |
user |
The user name. |
password |
The user’s password. |
database |
The database name. |
tunnel_host |
SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port |
SSH port, specify only to connect via an SSH tunnel. |
tunnel_user |
SSH user, specify only to connect via an SSH tunnel. |
update_method |
The method to detect new or changed rows. Specify only for "service": "postgres" or "service": "postgres_rds" . Supported values: WAL - this method replicates new, changed and deleted rows by tailing the write-ahead log (WAL) via a logical slot. This is more efficient than the XMIN method, but requires more setup and monitoring.XMIN - this method detects new or changed rows via the XMIN system column, but is not capable of detecting deleted rows.WAL_PGOUTPUT - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. |
replication_slot |
Replication slot name. Specify only for "updated_method": "WAL" or "WAL_PGOUTPUT" . |
connection_type |
Possible values:Directly ,PrivateLink , SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter’s values is specified: tunnel_host , tunnel_port , tunnel_user . Otherwise, Directly is used as a value if the parameter is omitted. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
,password
anddatabase
. - By using the Connect Card or the Fivetran dashboard.
Qualtricslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "qualtrics",
"group_id": "target_group_id",
"config": {
"schema": "test_qualtrics",
"data_center": "data_center",
"api_token": "api_token"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
data_center |
Data center ID of the Qualtrics account. Can be found in the URL before qualtrics.com . (For example, if your URL is youraccount.ca1.qualtrics.com , then the data center is ca1 .) |
api_token |
API token of the Qualtrics account. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
data_center
andapi_token
. - By using the Connect Card or the Fivetran dashboard.
QuickBookslink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "quickbooks",
"group_id": "target_group_id",
"config": {
"schema": "test_quickbooks"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
,refresh_token
, andrealm_id
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "quickbooks", "group_id": "target_group_id", "config": { "schema": "test_quickbooks" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token", "realm_id": "my_realm_id" } }
Auth parameters
Name Description client_id
Client ID
of your QuickBooks client application.client_secret
Client Secret
of your QuickBooks client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.realm_id
Realm ID
of your QuickBooks application. -
By using the Connect Card or the Fivetran dashboard.
ReChargelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "recharge",
"group_id": "target_group_id",
"config": {
"schema": "test_recharge",
"api_token": "recharge_token"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_token |
The Recharge API token. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
Recurlylink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "recurly",
"group_id": "target_group_id",
"config": {
"schema": "test_recurly",
"sub_domain": "recurly_subdomain",
"api_key": "recurly_api_key"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
sub_domain |
Your company’s Recurly subdomain. |
api_key |
The Recurly API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sub_domain
andapi_key
. - By using the Connect Card or the Fivetran dashboard.
Sage Intacct Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "sage_intacct",
"group_id": "target_group_id",
"config": {
"schema": "test_intacct",
"company_id": "test_company_id",
"user_id": "test_user_id",
"login_password": "xxxxxxxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
company_id |
The company ID that is used to set up the Sage Intacct instance. It is a part of the Sage Intacct instance’s login credentials. |
user_id |
The Sage Intacct user ID. It is a part of the login credentials. |
login_password |
The login password. It is a part of the login credentials. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
company_id
,user_id
andlogin_password
. - By using the Connect Card or the Fivetran dashboard.
Sailthrulink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "sailthru",
"group_id": "target_group_id",
"config": {
"schema": "sailthru",
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"api_secret": "your_api_secret"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
The Sailthru API key. |
api_secret |
The Sailthru API secret. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
api_key
andapi_secret
. - By using the Connect Card or the Fivetran dashboard.
Salesforcelink
Requestlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Use salesforce_sandbox
service name for sandbox account or salesforce
service name for production account.
POST https://api.fivetran.com/v1/connectors
{
"service": "salesforce",
"group_id": "target_group_id",
"config": {
"schema": "salesforce",
"base_url": "https://base_url.salesforce.com"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
base_url |
(Optional) The custom Salesforce domain. Make sure that the base_url starts with https:// . |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "salesforce", "group_id": "target_group_id", "config": { "schema": "salesforce", "base_url": "https://base_url.salesforce.com" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Salesforce client application.client_secret
Client Secret
of your Salesforce client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Salesforce Marketing Cloudlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "salesforce_marketing_cloud",
"group_id": "target_group_id",
"config": {
"schema": "test_sfmc",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"client_secret": "your_api_secret",
"instance": "",
"is_new_package": "true"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
client_id |
The Salesforce Marketing Cloud client ID. | |
client_secret |
The Salesforce Marketing Cloud client secret. | |
instance |
The Salesforce Marketing Cloud instance ID | s1 , s4 , s5 , s6 , s7 , s8 , s10 , s50 |
is_new_package |
Indicates that that your installed package uses OAuth 2.0. Default value: false |
true , false |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
client_id
,client_secret
andinstance
. - By using the Connect Card or the Fivetran dashboard.
SAP Business ByDesign Private Previewlink
Requestlink
POST api.fivetran.com/v1/connectors
{
"service": "sap_business_by_design",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_business_bydesign",
"username" : "your_sap_business_bydesign_username",
"password" : "your_sap_business_bydesign_password",
"instance_url": "your_sap_business_bydesign_instance_url"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
username |
The SAP Business ByDesign username. |
password |
The SAP Business ByDesign password. |
instance_url |
The SAP Business ByDesign instance URL. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
username
,password
, andinstance_url
. - By using the Connect Card or the Fivetran dashboard.
SAP Concurlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "sap_concur",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_concur",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"client_secret": "your_application_secret",
"username" : "your_sap_concur_username",
"login_password" : "your_login_password",
"region" : "your_region"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id |
The SAP Concur Client ID. |
client_secret |
The SAP Concur Client secret. |
username |
The SAP Concur username. |
login_password |
The SAP Concur password. |
region |
The region. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
client_id
,client_secret
,username
,login_password
, andregion
. - By using the Connect Card or the Fivetran dashboard.
SAP HANA Private Previewlink
IMPORTANT: We have disabled new connector creation using our REST API.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "sap_hana",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_hana",
"host": "sap_hana_host",
"port": 1521,
"database": "sap_hana_database",
"user": "sap_hana_user",
"password": "sap_hana_password",
"test_table_name": "sap_hana_test_table_name",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host |
The SAP HANA host or IP address. |
port |
The SAP HANA port number. |
user |
Your SAP HANA user name. |
password |
Your SAP HANA password. |
database |
The database name. |
testTableName |
The table name to test the connection. By default, we use the T503K table. |
tunnel_host |
SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port |
SSH port, specify only to connect via an SSH tunnel. |
tunnel_user |
SSH user, specify only to connect via an SSH tunnel. |
connection_type |
Possible values:Directly ,PrivateLink , SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter’s values is specified: tunnel_host , tunnel_port , tunnel_user . Otherwise, Directly is used as a value if the parameter is omitted. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
,password
,database
,testTableName
,tunnel_host
,tunnel_port
, andtunnel_user
. - By using the Connect Card or the Fivetran dashboard.
SAP S/4 Private Previewlink
IMPORTANT: We have disabled new connector creation using our REST API.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "sap_s4hana",
"group_id": "target_group_id",
"config": {
"schema": "test_sap_s4",
"host": "sap_s4_host",
"port": 1521,
"database": "sap_s4_database",
"user": "sap_s4_user",
"password": "sap_s4_password",
"test_table_name": "sap_s4_test_table_name",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host |
The SAP S/4 host or IP address. |
port |
The SAP S/4 port number. |
user |
Your SAP S/4 user name. |
password |
Your SAP S/4 password. |
database |
The database name. |
testTableName |
The table name to test the connection. By default, we use the T503K table. |
tunnel_host |
SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port |
SSH port, specify only to connect via an SSH tunnel. |
tunnel_user |
SSH user, specify only to connect via an SSH tunnel. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
,password
,database
,testTableName
,tunnel_host
,tunnel_port
andtunnel_user
. - By using the Connect Card or the Fivetran dashboard.
Segmentlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "segment",
"group_id": "target_group_id",
"config": {
"schema": "test_segment_webhook",
"sync_type": "Webhook"
}
}
{
"service": "segment",
"group_id": "target_group_id",
"config": {
"schema": "test_segment_s3",
"sync_type": "S3",
"prefix": "prefix",
"bucket": "bucket",
"role_arn": "role_arn"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_type |
The Segment connector sync type. | Webhook , S3 |
prefix |
Folder path to the Segment files within the bucket. Must be populated if sync_type is set to S3 . |
|
bucket |
The name of the Segment bucket. Must be populated if sync_type is set to S3 . |
|
role_arn |
The Role ARN required for authentication. Must be populated if sync_type is set to S3 . |
Authorizationlink
There are three ways to authorize this connector type:
- By specifying the following fields in the request:
prefix
,bucket
, androle_arn
, ifsync_type
is set toS3
. - By specifying the field
sync_type
aswebhook
, if you are connecting using only webhooks. - By using the Connect Card or the Fivetran dashboard.
SendGridlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "sendgrid",
"group_id": "target_group_id",
"config": {
"schema": "test_sendgrid",
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
api_key |
The SendGrid API key. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
api_key
field in the request. - By using the Connect Card or the Fivetran dashboard.
ServiceNowlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "servicenow",
"group_id": "target_group_id",
"config": {
"schema": "stripe_schema",
"instance": "instance_id",
"client_id": "client_id",
"client_secret": "client_secret",
"username": "username",
"password": "password"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
instance |
ServiceNow Instance ID. |
client_id |
ServiceNow Client ID. |
client_secret |
ServiceNow Client Secret. |
username |
Your ServiceNow User ID (username). |
password |
Your account password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
instance
,client_id
,client_secret
,username
andpassword
. - By using the Connect Card or the Fivetran dashboard.
SFTPlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "sftp",
"group_id": "target_group_id",
"config": {
"schema": "test_sftp",
"table": "table_name",
"host": "sftp.company.com",
"port": "22",
"is_keypair": "false",
"user": "user_name",
"password": "password",
"prefix": "folder_path",
"pattern": "file_pattern",
"file_type": "infer",
"compression": "infer",
"on_error": "skip",
"append_file_option": "upsert_file",
"archive_pattern": "regex_pattern",
"null_sequence": "",
"delimiter": "",
"escape_char": "",
"skip_before": "0",
"skip_after": "0"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
host |
SFTP host address. | |
port |
SFTP port. | |
user |
SFTP user. | |
password |
SFTP password. | |
is_keypair |
Whether to use a key pair for authentication. When true , do not use password . |
true , false |
prefix |
All files and folders under this folder path will be searched for files to sync. | |
pattern |
All files in your search path matching this regular expression will be synced. | |
file_type |
If your files are saved with improper extensions, you can force them to by synced as the selected filetype. | infer , csv , json , tsv , avro |
compression |
The secrets that should be passed to the function at runtime. | infer , uncompressed , tar , tar_bz2 , tar_gz |
on_error |
If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. | fail , skip |
append_file_pption |
If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. | upsert_file , append_file |
archive_pattern |
Files inside of compressed archives with filenames matching this regular expression will be synced. | |
null_sequence |
If your CSVs use a special value indicating null, you can specify it here. | |
delimiter |
You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. | |
escape_char |
If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. | |
skip_before |
We will skip over the number of lines specified before syncing data. | |
skip_after |
We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. |
NOTE: The unique public key for your group may be viewed in the SFTP setup form.
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
andpassword
. - By using the Connect Card or the Fivetran dashboard.
SharePoint Betalink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "share_point",
"group_id": "target_group_id",
"config": {
"schema": "test_share_point",
"share_url": "target_folder_id"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema has to be unique within the group (destination). Required for connector creation. |
share_url |
Your SharePoint folder URL. You can find the folder URL by following the steps mentioned in the SharePoint Setup Guide. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "share_point", "group_id": "target_group_id", "config": { "schema": "test_share_point", "share_url": "target_share_url" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Microsoft client application.client_secret
Client Secret
of your Microsoft client application.refresh_token
The long-lived Refresh token carries the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Shopifylink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "shopify",
"group_id": "target_group_id",
"config": {
"schema": "shopify_schema",
"access_token": "access_token",
"shop": "shop_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_token |
The Shopify access token. |
shop |
The Shopify shop name. Can be found in the URL before .myshopify.com. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
access_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "shopify", "group_id": "target_group_id", "config": { "schema": "test_shopify", "shop": "my_shop" }, "auth": { "access_token" : "my_access_token" } }
Auth parameters
Name Description access_token
The Shopify access token. -
By using the Connect Card or the Fivetran dashboard.
Snapchat Adslink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "snapchat_ads",
"group_id": "target_group_id",
"config": {
"schema": "test_snapchat_ads",
"sync_mode": "SpecificOrganizations",
"organizations": ["abc","cde","def"],
"swipe_attribution_window": "DAY_7",
"view_attribution_window": "HOUR_3",
"timeframe_months": "THREE"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all organizations or specific organizations. Default value: AllOrganizations . |
AllOrganizations , SpecificOrganizations |
organizations |
Specific organizations IDs to sync. Must be populated if syncMode is set to SpecificOrganizations . |
|
swipe_attribution_window |
The time period to attribute conversions based on swipes. Default value: DAY_28 |
DAY_1 , DAY_7 , DAY_28 |
view_attribution_window |
The time period to attribute conversions based on views. Default value: DAY_1 |
HOUR_1 , HOUR_3 , HOUR_6 , DAY_1 , DAY_7 , DAY_28 |
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "snapchat_ads", "group_id": "target_group_id", "config": { "schema": "test_snapchat_ads", "sync_mode": "SpecificOrganizations", "organizations": ["abc","cde","def"], "swipe_attribution_window": "DAY_7", "view_attribution_window": "HOUR_3", "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Snapchat Ads client application.client_secret
Client Secret
of your Snapchat Ads client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
Snowplowlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "snowplow",
"group_id": "target_group_id",
"config": {
"schema": "schema_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Initial Configurationlink
Copy the code snippet into the <head>
section of your web page.
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
Splunk Betalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "splunk",
"group_id": "target_group_id",
"config": {
"schema": "schema",
"host": "host",
"port": 8089,
"user": "user",
"password": "password"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
host |
The Splunk service host address. |
port |
The Splunk service host port. |
user |
The Splunk username. |
password |
The Splunk user’s password. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,user
andpassword
. - By using the Connect Card or the Fivetran dashboard.
SQL Serverlink
Fivetran supports a few different incarnations of SQL Server.
Each type of connector has its own service
value:
- Azure -
"service": "azure_sql_db"
- Generic PostgreSQL -
"service": "sql_server"
- RDS -
"service": "sql_server_rds"
Check out our setup guide for your type of connector.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "sql_server",
"group_id": "target_group_id",
"config": {
"schema_prefix": "test_sql",
"host": "sqlinstance.mycompany.com",
"port": 1433,
"database": "sqldb",
"user": "test_user",
"password": "test_password",
"tunnel_host": "XXX.XXX.XXX.XXX",
"tunnel_port": 22,
"tunnel_user": "fivetran"
}
}
Config parameters
Name | Description |
---|---|
schema_prefix |
The connector schema prefix has to be unique within the group (destination). Required for connector creation. |
host |
DB instance host or IP address. |
port |
The port number. |
user |
The user name. For Azure Databases, the format must be user@domain . |
password |
The user’s password. |
database |
The database name. |
tunnel_host |
SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
tunnel_port |
SSH port, specify only to connect via an SSH tunnel. |
tunnel_user |
SSH user, specify only to connect via an SSH tunnel. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
host
,port
,password
,user
anddatabase
. - By using the Connect Card or the Fivetran dashboard.
Squarelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "square",
"group_id": "group_id",
"config": {
"schema": "square_schema",
"client_id": "clientId",
"api_access_token": "accessToken"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id |
The Application ID specific to your organization. |
api_access_token |
Square App user the access token specific to your Application. |
Retrieving the access tokenlink
- Log in to https://developer.squareup.com/apps with your personal credentials and click on the View Details option displayed under your Application ID.
- Switch to Production Settings option in the bottom left corner.
- Select Credentials menu on the left side of the screen.
- Click on Show option for Personal Access Token tab.
- Copy the
access Token
.
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
client_id
andapi_access_token
. - By using the Connect Card or the Fivetran dashboard.
Stripelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "stripe",
"group_id": "target_group_id",
"config": {
"schema": "stripe_schema",
"access_token": "restricted_key"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
access_token |
The Stripe API Restricted Key |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the
access_token
field in the request. - By using the Connect Card or the Fivetran dashboard.
SurveyMonkeylink
Requestlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
POST https://api.fivetran.com/v1/connectors
{
"service": "survey_monkey",
"group_id": "target_group_id",
"config": {
"schema": "test_survey_monkey",
"eu_region": true
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
eu_region |
The SurveyMonkey account region. Specify true , if your account is hosted in the EU region. Default value is false . |
true , false |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andaccess_token
in theauth section
.POST https://api.fivetran.com/v1/connectors
{ "service": "survey_monkey", "group_id": "target_group_id", "config": { "schema": "test_survey_monkey", "eu_region" : false }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }
Auth parameters
Name Description client_id
Client ID
of your SurveyMonkey client application.client_secret
Client Secret
of your SurveyMonkey client application.access_token
The long-lived Access token
carry the information necessary to access API resources. -
By using Connect Card or through the Fivetran dashboard.
Taboolalink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "taboola",
"group_id": "target_group_id",
"config": {
"schema": "test_taboola",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"client_secret": "your_api_secret",
"sync_mode": "AllAccounts",
"account_ids": "account_id1, account_id2"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
client_id |
The Taboola client ID. | |
client_secret |
The Taboola client secret. | |
sync_mode |
Whether to sync all accounts or specific accounts. | AllAccounts , SpecificAccounts |
account_ids |
Specific Account IDs to sync. Must be populated if syncMode is set to SpecificAccounts . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
client_id
,client_secret
andaccess_token
. - By using the Connect Card or the Fivetran dashboard.
The Trade Desk Private Previewlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "the_trade_desk",
"group_id": "target_group_id",
"config": {
"schema": "test_trade_desk",
"login": "test_login",
"password": "xxxxxxxxxx",
"sync_mode": "SpecificAccounts",
"partners": ["partner_id1", "partner_id2"]
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
login |
The Trade Desk email. It is a part of the login credentials. | |
password |
The Trade Desk password. It is a part of the login credentials. | |
sync_mode |
Whether to sync all accounts or specific accounts. | AllAccounts , SpecificAccounts |
partners |
Specific Partner IDs to sync. Must be populated if syncMode is set to SpecificAccounts . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
login
andpassword
. - By using the Connect Card or the Fivetran dashboard.
TikTok Adslink
Requestlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
POST https://api.fivetran.com/v1/connectors
{
"service": "tiktok_ads",
"group_id": "target_group_id",
"config": {
"schema": "tiktok_ads",
"sync_mode": "SpecificAccounts",
"accounts": ["123","543"],
"timeframe_months": "THREE"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all advertiser accounts or specific accounts. | AllAccounts , SpecificAccounts |
accounts |
Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts . |
|
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: THREE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andaccess_token
in theauth section
.POST https://api.fivetran.com/v1/connectors
{ "service": "tiktok_ads", "group_id": "target_group_id", "config": { "schema": "tiktok_ads", "sync_mode": "SpecificAccounts", "accounts": ["123"], "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "access_token": "my_access_token" } }
Auth parameters
Name Description client_id
Client ID
of your TikTok Ads client application.client_secret
Client Secret
of your TikTok Ads client application.access_token
The long-lived Access token
carries the information necessary to access API resources. -
By using the Connect Card or through the Fivetran dashboard.
Twiliolink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "twilio",
"group_id": "group_id",
"config": {
"schema": "test_twilio",
"sid":"test_api_sid",
"secret":"test_api_secret",
"accounts":[
"test_account_sid"
],
"sync_mode":"SpecificAccounts"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sid |
The Twilio API key SID | |
secret |
The Twilio API secret | |
accounts |
Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts . |
|
sync_mode |
Whether to sync all accounts or specific accounts. | AllAccounts , SpecificAccounts |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
sid
,secret
,sync_mode
andaccounts
. - By using the Connect Card or the Fivetran dashboard.
Twitter Organiclink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "twitter",
"group_id": "target_group_id",
"config": {
"schema": "twitter_schema",
"sync_mode": "SpecificAccounts",
"accounts": ["twitteraccount1","twitteraccount2"],
"timeframe_months": "TWELVE"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. Default value: AllAccounts . |
AllAccounts , SpecificAccounts |
accounts |
Specific accounts to sync. Must be populated if sync_mode is set to SpecificAccounts . |
|
timeframe_months |
Number of months of data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: THREE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying values for the
client_id
,client_secret
,oauth_token
, andoauth_token_secret
parameters in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "twitter", "group_id": "target_group_id", "config": { "schema": "twitter_schema", "sync_mode": "SpecificAccounts", "accounts": ["twitteraccount1","twitteraccount2"], "timeframe_months": "TWELVE" }, "auth": { "client_access": { "client_id": "my_consumer_key", "client_secret": "my_consumer_secret" }, "oauth_token": "twitter_access_token", "oauth_token_secret": "twitter_access_token_secret" } }
Auth parameters
Name Description client_id
The Twitter App consumer key. client_secret
The Twitter App consumer secret. oauth_token
The Twitter App access token. oauth_token_secret
The Twitter App access token secret. -
By using the Connect Card or through the Fivetran dashboard.
Twitter Adslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "twitter_ads",
"group_id": "group_id",
"config": {
"schema": "test_twitter",
"oauth_token":"twitter_access_token",
"oauth_token_secret":"twitter_access_token_secret",
"consumer_key":"twitter_key",
"consumer_secret":"twitter_secret",
"accounts":[
"twitter_account1"
],
"sync_mode":"SpecificAccounts",
"timeframe_months": "timeframe_months"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
oauth_token |
The Twitter App access token. | |
oauth_token_secret |
The Twitter App access token secret. | |
consumer_key |
The Twitter App consumer key. | |
consumer_secret |
The Twitter App consumer secret. | |
accounts |
Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts . |
|
sync_mode |
Whether to sync all accounts or specific accounts. | AllAccounts , SpecificAccounts |
timeframe_months |
Historical sync timeframe in months. | THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
oauth_token
,oauth_token_secret
,consumer_key
andconsumer_secret
. - By using the Connect Card or the Fivetran dashboard.
Typeformlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "typeform",
"group_id": "target_group_id",
"config": {
"schema": "typeform"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
,refresh_token
, andaccess_token
(optional) in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "typeform", "group_id": "target_group_id", "config": { "schema": "typeform" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token", "access_token": "my_access_token" } }
Auth parameters
Name Description client_id
The Typeform client ID. client_secret
The Typeform client secret. refresh_token
The Typeform API refresh token. access_token
The Typeform API access token. -
By using the Connect Card or the Fivetran dashboard.
UserVoicelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "uservoice",
"group_id": "target_group_id",
"config": {
"schema": "test_uservoice",
"domain": "uservoice_domain",
"key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"secret": "your_api_secret"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
domain |
Domain of your UserVoice site. If it ends with “.uservoice.com”, you can specify just the subdomain (“mydomain.uservoice.com” → “mydomain”) |
key |
The UserVoice API key. |
secret |
The UserVoice API secret. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
domain
,key
andsecret
. - By using the Connect Card or the Fivetran dashboard.
Verizon Medialink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "yahoo_gemini",
"group_id": "target_group_id",
"config": {
"schema": "test_yahoo_gemini",
"sync_mode": "SpecificAccounts",
"advertisers_id": ["123","234","345"],
"timeframe_months": "THREE"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
sync_mode |
Whether to sync all accounts or specific accounts. Default value: SpecificAccounts . |
SpecificAccounts , AllAccounts |
advertisers_id |
Specific Advertiser IDs to sync. Must be populated if syncMode is set to SpecificAccounts . |
|
timeframe_months |
Number of months of reporting data you’d like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE . |
THREE , SIX , TWELVE , TWENTY_FOUR , ALL_TIME |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "yahoo_gemini", "group_id": "target_group_id", "config": { "schema": "test_yahoo_gemini", "sync_mode": "SpecificAccounts", "advertisers_id": ["123","234","345"], "timeframe_months": "THREE" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Yahoo Gemini client application.client_secret
Client Secret
of your Yahoo Gemini client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
Webhookslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "webhooks",
"group_id": "target_group_id",
"config": {
"schema": "schema_name",
"table": "table_name",
"sync_format": "Packed",
"bucket_service": "S3",
"s3_bucket": "your_bucket_name",
"s3_role_arn": "arn::your_role_arn"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
sync_format |
The webhooks sync format. Default value: Unpacked . Unpacked messages must be valid JSON. |
Unpacked , Packed |
bucket_service |
Whether to store the events in Fivetran’s container service or your S3 bucket. Default value: Fivetran . |
Fivetran , S3 |
s3_bucket |
The S3 bucket name. Required if bucket_service is set to S3 . |
|
s3_role_arn |
The Role ARN required for authentication. Required if bucket_service is set to S3 . |
Authorizationlink
There are three ways to authorize this connector type:
- By specifying the following fields in the request:
s3_bucket
ands3_role_arn
, ifbucket_service
is set toS3
. - By specifying the field
bucket_service
asFivetran
. - By using the Connect Card or the Fivetran dashboard.
Workdaylink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "workday",
"group_id": "target_group_id",
"config": {
"schema": "test_workday",
"table": "workday_report_table",
"user_name": "workday_username",
"password": "workday_password",
"report_url": "workday_report_url"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. |
user_name |
Workday username. |
password |
Workday password. |
report_url |
URL for a live custom report. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
user_name
,password
andreport_url
. - By using the Connect Card or the Fivetran dashboard.
Workday HCMlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "workday_hcm",
"group_id": "target_group_id",
"config": {
"schema": "test_workday_hcm",
"user_name": "workday_username",
"password": "workday_password",
"domain_host_name": "your_workday_host_name"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
user_name |
Workday username. |
password |
Workday password. |
domain_host_name |
Workday host name. |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
user_name
,password
anddomain_host_name
. - By using the Connect Card or the Fivetran dashboard.
Xerolink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "xero",
"group_id": "target_group_id",
"config": {
"schema": "xero_schema"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.
YouTube Analyticslink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "youtube_analytics",
"group_id": "target_group_id",
"config": {
"schema": "test_youtube_analytics",
"table": "test_table",
"report_type": "playlist_playback_location_a1",
"content_owner_id": "content_owner_id"
}
}
Config parameters
Name | Description | Possible Values |
---|---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. | |
table |
The table name within the schema to which connector will sync the data. Required for connector creation. | |
report_type |
The name of report of which connector will sync the data. | See Channel Reports, Content Owner Reports. |
content_owner_id |
Used only for Content Owner reports. The ID of the content owner for whom the API request is being made. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "youtube_analytics", "group_id": "target_group_id", "config": { "schema": "test_youtube_analytics", "table": "test_table", "report_type": "playlist_playback_location_a1", "content_owner_id": "content_owner_id" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret", }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your YouTube Analytics client application.client_secret
Client Secret
of your YouTube Analytics client application.refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources. -
By using the Connect Card or the Fivetran dashboard.
Zendesk Chatlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "zendesk_chat",
"group_id": "target_group_id",
"config": {
"schema": "test_zendesk_chat",
"subdomain": "zendesk_domain",
"client_id": "test_client_id",
"client_secret": "test_client_secret"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
subdomain |
Your Zendesk domain. |
client_id |
Your Zendesk client ID. |
client_secret |
Your Zendesk client secret. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
access_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "zendesk_chat", "group_id": "target_group_id", "config": { "schema": "zendesk_chat" }, "auth": { "access_token": "my_access_token" } }
Auth parameters
Name Description access_token
The long-lived Access token
carry the information necessary to access API resources. -
By using the Connect Card or through the Fivetran dashboard.
Zendesk Selllink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "zendesk_sell",
"group_id": "target_group_id",
"config": {
"schema": "test_zendesk_sell"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
access_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "zendesk_sell", "group_id": "target_group_id", "config": { "schema": "zendesk_sell" }, "auth": { "access_token": "my_access_token" } }
Auth parameters
Name Description access_token
The long-lived Access token
carry the information necessary to access API resources.See Zendesk Sell’s guide for instructions to generate the
access_token
. -
By using the Connect Card or through the Fivetran dashboard.
Zendesk Sunshinelink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "zendesk_sunshine",
"group_id": "target_group_id",
"config": {
"schema": "zendesk_sunshine",
"domain": "domain",
"email": "email",
"api_token": "api_token"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
domain |
Zendesk domain. |
email |
Zendesk email. |
api_token |
Zendesk API tokens are auto-generated passwords in the Support admin interface. |
See Zendesk’s guide for instructions to generate the api_token
.
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
domain
,email
andapi_token
. - By using the Connect Card or the Fivetran dashboard.
Zendesk Supportlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "zendesk",
"group_id": "target_group_id",
"config": {
"schema": "zendesk",
"domain": "domain",
"email": "email",
"api_token": "api_token"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
domain |
Zendesk domain. |
email |
Zendesk email. |
api_token |
Zendesk API tokens are auto-generated passwords in the Support admin interface. |
See Zendesk’s guide for instructions to generate the api_token
.
Authorizationlink
There are three ways to authorize this connector type:
-
By specifying the following fields in the request:
domain
,email
andapi_token
. -
By specifying
access_token
in theauth
section.POST https://api.fivetran.com/v1/connectors
{ "service": "zendesk", "group_id": "target_group_id", "config": { "schema": "zendesk" }, "auth": { "access_token": "my_access_token" } }
Auth parameters
Name Description access_token
The long-lived Access token
carry the information necessary to access API resources. -
By using the Connect Card or the Fivetran dashboard.
Zoho CRMlink
The following example will allow you to create a new connector without authorization. If you want to authorize your connector during its creation, you should add the auth
section to the request body and define its parameters or perform other actions depending on the authorization type.
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "zoho",
"group_id": "target_group_id",
"config": {
"schema": "test_zoho",
"data_center": "data_center"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
data_center |
Data center of the Zoho CRM account. |
Authorizationlink
There are two ways to authorize this connector type:
-
By specifying
client_access
andrefresh_token
in theauth
section.POST api.fivetran.com/v1/connectors
{ "service": "zoho", "group_id": "target_group_id", "config": { "schema": "test_zoho", "data_center": "data_center" }, "auth": { "client_access": { "client_id": "my_client_id", "client_secret": "my_client_secret" }, "refresh_token": "my_refresh_token" } }
Auth parameters
Name Description client_id
Client ID
of your Zoho client application.client_secret
Client Secret
of your Zoho client application.refresh_token
The long-lived Refresh token
, along with theclient_id
andclient_secret
parameters, carries the information necessary to get a new access token for API resources. -
By using the Connect Card or through the Fivetran dashboard.
Zuoralink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "zuora",
"group_id": "target_group_id",
"config": {
"schema": "test_zuora",
"client_id": "zuora_client_id",
"client_secret": "zuora_client_secret",
"is_multi_entity_feature_enabled": true,
"entity_id": "zuora_entity_id"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id |
Zuora Client ID. |
client_secret |
Zuora Client Secret. |
is_multi_entity_feature_enabled |
Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false . |
entity_id |
If is_multi_entity_feature_enabled is true , then it’s EntityId . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
username
,password
andunique_id
. - By using the Connect Card or the Fivetran dashboard.
Zuora Sandboxlink
Requestlink
POST https://api.fivetran.com/v1/connectors
{
"service": "zuora_sandbox",
"group_id": "target_group_id",
"config": {
"schema": "test_zuora",
"client_id": "zuora_client_id",
"client_secret": "zuora_client_secret",
"is_multi_entity_feature_enabled": true,
"entity_id": "zuora_entity_id",
"environment": "zuora_sandbox_environment"
}
}
Config parameters
Name | Description |
---|---|
schema |
The connector schema name has to be unique within the group (destination). Required for connector creation. |
client_id |
Zuora Client ID. |
client_secret |
Zuora Client Secret. |
is_multi_entity_feature_enabled |
Set to true if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to false . |
entity_id |
If is_multi_entity_feature_enabled is true , then it’s EntityId . |
environment |
Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox . |
Authorizationlink
There are two ways to authorize this connector type:
- By specifying the following fields in the request:
username
,password
andunique_id
. - By using the Connect Card or the Fivetran dashboard.