---
title: "List sources"
method: GET
path: "/sources"
tags: ["public_sources", "public", "Sources"]
---
# List sources
`GET /sources`
## Query parameters
- `workspaceIds` string[]
- `includeDeleted` boolean
- `limit` integer
- `offset` integer
## Response `200`
Successful operation
- SourcesResponse
- `previous` string
- `next` string
- `data` SourceResponse[], required
- `sourceId` string, UUID, required
- `name` string, required
- `sourceType` string, required
- `definitionId` string, UUID, required
- `workspaceId` string, UUID, required
- `configuration` union, required — The values required to configure the source.
- SourceAha
- `api_key` string, required — API Key
- `url` string, required — URL
- `sourceType` 'aha', required
- Source100ms
- `management_token` string, required — The management token used for authenticating API requests. You can find or generate this token in your 100ms dashboard under the API section. Refer to the documentation at https://www.100ms.live/docs/concepts/v2/concepts/security-and-tokens#management-token-for-rest-api for more details.
- `start_date` string, date-time, required
- `sourceType` '100ms', required
- Source7shifts
- `access_token` string, required — Access token to use for authentication. Generate it in the 7shifts Developer Tools.
- `start_date` string, date-time, required
- `sourceType` '7shifts', required
- SourceActivecampaign
- `account_username` string, required — Account Username
- `api_key` string, required — API Key
- `sourceType` 'activecampaign', required
- SourceAcuityScheduling
- `password` string
- `start_date` string, date-time, required
- `username` string, required
- `sourceType` 'acuity-scheduling', required
- SourceAdobeCommerceMagento
- `api_key` string, required
- `api_version` string — V1
- `start_date` string, date-time, required
- `store_host` string, required — magento.mystore.com
- `sourceType` 'adobe-commerce-magento', required
- SourceAgilecrm
- `api_key` string, required — API key to use. Find it at Admin Settings -> API & Analytics -> API Key in your Agile CRM account.
- `domain` string, required — The specific subdomain for your Agile CRM account
- `email` string, required — Your Agile CRM account email address. This is used as the username for authentication.
- `sourceType` 'agilecrm', required
- SourceAirbyte
- `client_id` string, required
- `client_secret` string, required
- `host` string — The Host URL of your Self-Managed Deployment (e.x. airbtye.mydomain.com)
- `start_date` string, date-time, required
- `sourceType` 'airbyte', required
- SourceAircall
- `api_id` string, required — App ID found at settings https://dashboard.aircall.io/integrations/api-keys
- `api_token` string, required — App token found at settings (Ref- https://dashboard.aircall.io/integrations/api-keys)
- `start_date` string, date-time, required — Date time filter for incremental filter, Specify which date to extract from.
- `sourceType` 'aircall', required
- SourceAirtable
- `credentials` union
- object
- `access_token` string — Access Token for making authenticated requests.
- `auth_method` 'oauth2.0'
- `client_id` string, required — The client ID of the Airtable developer application.
- `client_secret` string, required — The client secret of the Airtable developer application.
- `refresh_token` string, required — The key to refresh the expired access token.
- `token_expiry_date` string, date-time — The date-time when the access token should be refreshed.
- object
- `api_key` string, required — The Personal Access Token for the Airtable account. See the Support Guide for more information on how to obtain this token.
- `auth_method` 'api_key'
- `sourceType` 'airtable'
- SourceAkeneo
- `api_username` string, required
- `client_id` string, required
- `host` string, required — https://cb8715249e.trial.akeneo.cloud
- `password` string, required
- `secret` string
- `sourceType` 'akeneo', required
- SourceAlgolia
- `api_key` string, required
- `application_id` string, required — The application ID for your application found in settings
- `object_id` string — Object ID within index for search queries
- `search_query` string — Search query to be used with indexes_query stream with format defined in `https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex`
- `start_date` string, date-time, required
- `sourceType` 'algolia', required
- SourceAlpacaBrokerApi
- `environment` 'api' | 'paper-api' | 'broker-api.sandbox', required — The trading environment, either 'live', 'paper' or 'broker-api.sandbox'.
- `limit` string — Limit for each response objects
- `password` string — Your Alpaca API Secret Key. You can find this in the Alpaca developer web console under your account settings.
- `start_date` string, date-time, required
- `username` string, required — API Key ID for the alpaca market
- `sourceType` 'alpaca-broker-api', required
- SourceAlphaVantage
- `adjusted` boolean — Whether to return adjusted data. Only applicable to intraday endpoints.
- `api_key` string, required — API Key
- `interval` '1min' | '5min' | '15min' | '30min' | '60min' — Time-series data point interval. Required for intraday endpoints.
- `outputsize` 'compact' | 'full' — Whether to return full or compact data (the last 100 data points).
- `symbol` string, required — Stock symbol (with exchange code)
- `sourceType` 'alpha-vantage', required
- SourceAmazonAds
- `auth_type` 'oauth2.0'
- `client_id` string, required — The client ID of your Amazon Ads developer application. See the docs for more information.
- `client_secret` string, required — The client secret of your Amazon Ads developer application. See the docs for more information.
- `look_back_window` integer — The amount of days to go back in time to get the updated data from Amazon Ads
- `marketplace_ids` string[] — Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
- `num_workers` integer — The number of worker threads to use for the sync.
- `profiles` integer[] — Profile IDs you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See docs for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID.
- `refresh_token` string, required — Amazon Ads refresh token. See the docs for more information on how to obtain this token.
- `region` 'NA' | 'EU' | 'FE' — Region to pull data from (EU/NA/FE). See docs for more details.
- `start_date` string, date — The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format
- `sourceType` 'amazon-ads', required
- SourceAmazonSellerPartner
- `account_type` 'Seller' | 'Vendor', required — Type of the Account you're going to authorize the Airbyte application by
- `app_id` string — Your Amazon Application ID.
- `auth_type` 'oauth2.0'
- `aws_environment` 'PRODUCTION' | 'SANDBOX', required — Select the AWS Environment.
- `financial_events_step` '1' | '7' | '14' | '30' | '60' | '90' | '180' — The time window size (in days) for fetching financial events data in chunks. Options are 1 day, 7 days, 14 days, 30 days, 60 days, and 190 days, based on API limitations. - **Smaller step sizes (e.g., 1 day)** are better for large data volumes. They fetch smaller chunks per request, reducing the risk of timeouts or overwhelming the API, though more requests may slow syncing and increase the chance of hitting rate limits. - **Larger step sizes (e.g., 14 days)** are better for smaller data volumes. They fetch more data per request, speeding up syncing and reducing the number of API calls, which minimizes strain on rate limits. Select a step size that matches your data volume to optimize syncing speed and API performance.
- `lwa_app_id` string, required — Your Login with Amazon Client ID.
- `lwa_client_secret` string, required — Your Login with Amazon Client Secret.
- `max_async_job_count` integer — The maximum number of concurrent asynchronous job requests that can be active at a time.
- `num_workers` integer — The number of workers to use for the connector when syncing concurrently.
- `period_in_days` integer — For syncs spanning a large date range, this option is used to request data in a smaller fixed window to improve sync reliability. This time window can be configured granularly by day.
- `refresh_token` string, required — The Refresh Token obtained via OAuth flow authorization.
- `region` 'AE' | 'AU' | 'BE' | 'BR' | 'CA' | 'DE' | 'EG' | 'ES' | 'FR' | 'GB' | 'IN' | 'IT' | 'JP' | 'MX' | 'NL' | 'PL' | 'SA' | 'SE' | 'SG' | 'TR' | 'UK' | 'US', required — Select the AWS Region.
- `replication_end_date` string, date-time — UTC date and time in the format 2017-01-25T00:00:00Z. Any data after this date will not be replicated.
- `replication_start_date` string, date-time — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If start date is not provided or older than 2 years ago from today, the date 2 years ago from today will be used.
- `report_options_list` object[] — Additional information passed to reports. This varies by report type.
- `options_list` object[], required — List of options
- `option_name` string, required
- `option_value` string, required
- `report_name` 'GET_AFN_INVENTORY_DATA' | 'GET_AFN_INVENTORY_DATA_BY_COUNTRY' | 'GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL' | 'GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA' | 'GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA' | 'GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA' | 'GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_REPLACEMENT_DATA' | 'GET_FBA_FULFILLMENT_REMOVAL_ORDER_DETAIL_DATA' | 'GET_FBA_FULFILLMENT_REMOVAL_SHIPMENT_DETAIL_DATA' | 'GET_FBA_INVENTORY_PLANNING_DATA' | 'GET_FBA_MYI_UNSUPPRESSED_INVENTORY_DATA' | 'GET_FBA_REIMBURSEMENTS_DATA' | 'GET_FBA_SNS_FORECAST_DATA' | 'GET_FBA_SNS_PERFORMANCE_DATA' | 'GET_FBA_STORAGE_FEE_CHARGES_DATA' | 'GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_SHIPPING' | 'GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_GENERAL' | 'GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL' | 'GET_FLAT_FILE_ARCHIVED_ORDERS_DATA_BY_ORDER_DATE' | 'GET_FLAT_FILE_OPEN_LISTINGS_DATA' | 'GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE' | 'GET_LEDGER_DETAIL_VIEW_DATA' | 'GET_LEDGER_SUMMARY_VIEW_DATA' | 'GET_MERCHANT_CANCELLED_LISTINGS_DATA' | 'GET_MERCHANT_LISTINGS_ALL_DATA' | 'GET_MERCHANT_LISTINGS_DATA' | 'GET_MERCHANT_LISTINGS_DATA_BACK_COMPAT' | 'GET_MERCHANT_LISTINGS_INACTIVE_DATA' | 'GET_MERCHANTS_LISTINGS_FYP_REPORT' | 'GET_ORDER_REPORT_DATA_SHIPPING' | 'GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT' | 'GET_SELLER_FEEDBACK_DATA' | 'GET_STRANDED_INVENTORY_UI_DATA' | 'GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE' | 'GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL' | 'GET_XML_BROWSE_TREE_DATA' | 'GET_VENDOR_REAL_TIME_INVENTORY_REPORT', required
- `stream_name` string, required
- `wait_to_avoid_fatal_errors` boolean — For report based streams with known amount of requests per time period, this option will use waiting time between requests to avoid fatal statuses in reports. See Troubleshooting section for more details
- `sourceType` 'amazon-seller-partner', required
- SourceAmazonSqs
- `access_key` string, required — The Access Key ID of the AWS IAM Role to use for pulling messages
- `attributes_to_return` string — Comma separated list of Mesage Attribute names to return
- `max_batch_size` integer — Max amount of messages to get in one batch (10 max)
- `max_wait_time` integer — Max amount of time in seconds to wait for messages in a single poll (20 max)
- `queue_url` string, required — URL of the SQS Queue
- `region` 'af-south-1' | 'ap-east-1' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-south-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-southeast-3' | 'ap-southeast-4' | 'ca-central-1' | 'ca-west-1' | 'cn-north-1' | 'cn-northwest-1' | 'eu-central-1' | 'eu-central-2' | 'eu-north-1' | 'eu-south-1' | 'eu-south-2' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'il-central-1' | 'me-central-1' | 'me-south-1' | 'sa-east-1' | 'us-east-1' | 'us-east-2' | 'us-gov-east-1' | 'us-gov-west-1' | 'us-west-1' | 'us-west-2', required — AWS Region of the SQS Queue
- `secret_key` string, required — The Secret Key of the AWS IAM Role to use for pulling messages
- `target` 'GetQueueAttributes' | 'ReceiveMessage' — Note - Different targets have different attribute enum requirements, please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html
- `visibility_timeout` integer — Modify the Visibility Timeout of the individual message from the Queue's default (seconds).
- `sourceType` 'amazon-sqs', required
- SourceAmplitude
- `active_users_group_by_country` boolean — According to Amplitude documentation, grouping by `Country` is optional. If you face issues fetching the stream or checking the connection please set this field to `False`.
- `api_key` string, required — Amplitude API Key. See the setup guide for more information on how to obtain this key.
- `data_region` 'Standard Server' | 'EU Residency Server' — Amplitude data region server
- `request_time_range` integer — According to Considerations too large of a time range in te request can cause a timeout error. In this case, please provide a shorter time interval in hours.
- `secret_key` string, required — Amplitude Secret Key. See the setup guide for more information on how to obtain this key.
- `start_date` string, date-time, required — UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.
- `sourceType` 'amplitude', required
- SourceApifyDataset
- `dataset_id` string, required — ID of the dataset you would like to load to Airbyte. In Apify Console, you can view your datasets in the Storage section under the Datasets tab after you login. See the Apify Docs for more information.
- `token` string, required — Personal API token of your Apify account. In Apify Console, you can find your API token in the Settings section under the Integrations tab after you login. See the Apify Docs for more information.
- `sourceType` 'apify-dataset', required
- SourceAppcues
- `account_id` string, required — Account ID of Appcues found in account settings page (https://studio.appcues.com/settings/account)
- `password` string
- `start_date` string, date-time, required
- `username` string, required
- `sourceType` 'appcues', required
- SourceAppfigures
- `api_key` string, required
- `group_by` 'network' | 'product' | 'country' | 'date' — Category term for grouping the search results
- `search_store` string — The store which needs to be searched in streams
- `start_date` string, date-time, required
- `sourceType` 'appfigures', required
- SourceAppfollow
- `api_secret` string — API Key provided by Appfollow
- `sourceType` 'appfollow', required
- SourceAppleSearchAds
- `backoff_factor` integer — This factor factor determines the delay increase factor between retryable failures. Valid values are integers between 1 and 20.
- `client_id` string, required — A user identifier for the token request. See here
- `client_secret` string, required — A string that authenticates the user’s setup request. See here
- `end_date` string — Data is retrieved until that date (included)
- `lookback_window` integer — Apple Search Ads uses a 30-day attribution window. However, you may consider smaller values in order to shorten sync durations, at the cost of missing late data attributions.
- `org_id` integer, required — The identifier of the organization that owns the campaign. Your Org Id is the same as your account in the Apple Search Ads UI.
- `start_date` string, required — Start getting data from that date.
- `timezone` 'ORTZ' | 'UTC', required — The timezone for the reporting data. Use 'ORTZ' for Organization Time Zone or 'UTC' for Coordinated Universal Time. Default is UTC.
- `token_refresh_endpoint` string, required — Token Refresh Endpoint. You should override the default value in scenarios where it's required to proxy requests to Apple's token endpoint
- `sourceType` 'apple-search-ads', required
- SourceAppsflyer
- `api_token` string, required — Pull API token for authentication. If you change the account admin, the token changes, and you must update scripts with the new token. Get the API token in the Dashboard.
- `app_id` string, required — App identifier as found in AppsFlyer.
- `start_date` string, required — The default value to use if no bookmark exists for an endpoint. Raw Reports historical lookback is limited to 90 days.
- `timezone` string — Time zone in which date times are stored. The project timezone may be found in the App settings in the AppsFlyer console.
- `sourceType` 'appsflyer', required
- SourceApptivo
- `access_key` string, required
- `api_key` string, required — API key to use. Find it in your Apptivo account under Business Settings -> API Access.
- `sourceType` 'apptivo', required
- SourceAsana
- `credentials` union — Choose how to authenticate to Github
- object
- `client_id` string, required
- `client_secret` string, required
- `option_title` 'OAuth Credentials' — OAuth Credentials
- `refresh_token` string, required
- object
- `option_title` 'PAT Credentials' — PAT Credentials
- `personal_access_token` string, required — Asana Personal Access Token (generate yours here).
- `num_workers` integer — The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Asana pricing plan. More info about the rate limit tiers can be found on Asana's API docs.
- `organization_export_ids` unknown[] — Globally unique identifiers for the organization exports
- unknown
- `sourceType` 'asana'
- SourceAshby
- `api_key` string, required — The Ashby API Key, see doc here.
- `start_date` string, required — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
- `sourceType` 'ashby', required
- SourceAssemblyai
- `api_key` string, required — Your AssemblyAI API key. You can find it in the AssemblyAI dashboard at https://www.assemblyai.com/app/api-keys.
- `request_id` string — The request ID for LeMur responses
- `start_date` string, date-time, required
- `subtitle_format` 'vtt' | 'srt', required — The subtitle format for transcript_subtitle stream
- `sourceType` 'assemblyai', required
- SourceAuth0
- `base_url` string, required — The Authentication API is served over HTTPS. All URLs referenced in the documentation have the following base `https://YOUR_DOMAIN`
- `credentials` union, required
- object
- `audience` string, required — The audience for the token, which is your API. You can find this in the Identifier field on your API's settings tab
- `auth_type` 'oauth2_confidential_application', required
- `client_id` string, required — Your application's Client ID. You can find this value on the application's settings tab after you login the admin portal.
- `client_secret` string, required — Your application's Client Secret. You can find this value on the application's settings tab after you login the admin portal.
- object
- `access_token` string, required — Also called API Access Token The access token used to call the Auth0 Management API Token. It's a JWT that contains specific grant permissions knowns as scopes.
- `auth_type` 'oauth2_access_token', required
- `start_date` string — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
- `sourceType` 'auth0', required
- SourceAviationstack
- `access_key` string, required — Your unique API key for authenticating with the Aviation API. You can find it in your Aviation account dashboard at https://aviationstack.com/dashboard
- `start_date` string, date-time, required
- `sourceType` 'aviationstack', required
- SourceAwinAdvertiser
- `advertiserId` string, required — Your Awin Advertiser ID. You can find this in your Awin dashboard or account settings.
- `api_key` string, required — Your Awin API key. Generate this from your Awin account under API Credentials.
- `lookback_days` integer, required — Number of days to look back on each sync to catch any updates to existing records.
- `start_date` string, date, required — Start date for data replication in YYYY-MM-DD format
- `step_increment` string, required — The time window size for each API request in ISO8601 duration format. For the campaign performance stream, Awin API explicitly limits the period between startDate and endDate to 400 days maximum.
- `sourceType` 'awin-advertiser', required
- SourceAwsCloudtrail
- `aws_key_id` string, required — AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key.
- `aws_region_name` string, required — The default AWS Region to use, for example, us-west-1 or us-west-2. When specifying a Region inline during client initialization, this property is named region_name.
- `aws_secret_key` string, required — AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key.
- `lookup_attributes_filter` object
- `attribute_key` string, required
- `attribute_value` string, required
- `start_date` string, date — The date you would like to replicate data. Data in AWS CloudTrail is available for last 90 days only. Format: YYYY-MM-DD.
- `sourceType` 'aws-cloudtrail', required
- SourceAzureBlobStorage — NOTE: When this Spec is changed, legacy_config_transformer.py must also be modified to uptake the changes because it is responsible for converting legacy Azure Blob Storage v0 configs into v1 configs using the File-Based CDK.
- `azure_blob_storage_account_name` string, required — The account's name of the Azure Blob Storage.
- `azure_blob_storage_container_name` string, required — The name of the Azure blob storage container.
- `azure_blob_storage_endpoint` string — This is Azure Blob Storage endpoint domain name. Leave default value (or leave it empty if run container from command line) to use Microsoft native from example.
- `credentials` union, required — Credentials for connecting to the Azure Blob Storage
- object
- `auth_type` 'oauth2', required
- `client_id` string, required — Client ID of your Microsoft developer application
- `client_secret` string, required — Client Secret of your Microsoft developer application
- `refresh_token` string, required — Refresh Token of your Microsoft developer application
- `tenant_id` string, required — Tenant ID of the Microsoft Azure Application user
- object
- `app_client_id` string, required — Client ID of your Microsoft developer application
- `app_client_secret` string, required — Client Secret of your Microsoft developer application
- `app_tenant_id` string, required — Tenant ID of the Microsoft Azure Application
- `auth_type` 'client_credentials', required
- object
- `auth_type` 'storage_account_key', required
- `azure_blob_storage_account_key` string, required — The Azure blob storage account key.
- `start_date` string, date-time — UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated.
- `streams` object[], required — Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table.
- `days_to_sync_if_history_is_full` integer — When the state history of the file store is full, syncs will only read files that were last modified in the provided day range.
- `format` union, required — The configuration options that are used to alter how to read incoming files that deviate from the standard formatting.
- object
- …
- object
- …
- object
- …
- object
- …
- object — Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one record per file.
- …
- object
- …
- `globs` string[] — The pattern used to specify which files should be selected from the file system. For more information on glob pattern matching look here.
- `input_schema` string — The schema that will be used to validate records extracted from the file. This will override the stream schema that is auto-detected from incoming files.
- `name` string, required — The name of the stream.
- `recent_n_files_to_read_for_schema_discovery` integer — The number of resent files which will be used to discover the schema for this stream.
- `schemaless` boolean — When enabled, syncs will not validate or structure records against the stream's schema.
- `validation_policy` 'Emit Record' | 'Skip Record' | 'Wait for Discover' — The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema.
- `sourceType` 'azure-blob-storage', required
- SourceAzureTable
- `storage_access_key` string, required — Azure Table Storage Access Key. See the docs for more information on how to obtain this key.
- `storage_account_name` string, required — The name of your storage account.
- `storage_endpoint_suffix` string — Azure Table Storage service account URL suffix. See the docs for more information on how to obtain endpoint suffix
- `sourceType` 'azure-table', required
- SourceBabelforce
- `access_key_id` string, required — The Babelforce access key ID
- `access_token` string, required — The Babelforce access token
- `date_created_from` integer — Timestamp in Unix the replication from Babelforce API will start from. For example 1651363200 which corresponds to 2022-05-01 00:00:00.
- `date_created_to` integer — Timestamp in Unix the replication from Babelforce will be up to. For example 1651363200 which corresponds to 2022-05-01 00:00:00.
- `region` 'services' | 'us-east' | 'ap-southeast', required — Babelforce region
- `sourceType` 'babelforce', required
- SourceBambooHr
- `api_key` string, required — Api key of bamboo hr
- `custom_reports_fields` string — Comma-separated list of fields to include in custom reports.
- `custom_reports_include_default_fields` boolean — If true, the custom reports endpoint will include the default fields defined here: https://documentation.bamboohr.com/docs/list-of-field-names.
- `employee_fields` string — Comma-separated list of fields to include for employees.
- `start_date` string, date-time
- `subdomain` string, required — Sub Domain of bamboo hr
- `sourceType` 'bamboo-hr', required
- SourceBasecamp
- `account_id` number, required
- `client_id` string, required
- `client_refresh_token_2` string, required
- `client_secret` string, required
- `start_date` string, date-time, required
- `sourceType` 'basecamp', required
- SourceBeamer
- `api_key` string, required
- `start_date` string, date-time, required
- `sourceType` 'beamer', required
- SourceBigmailer
- `api_key` string, required — API key to use. You can create and find it on the API key management page in your BigMailer account.
- `sourceType` 'bigmailer', required
- SourceBigquery
- `credentials_json` string, required — The contents of your Service Account Key JSON file. See the docs for more information on how to obtain this key.
- `dataset_id` string — The dataset ID to search for tables and views. If you are only loading data from one dataset, setting this option could result in much faster schema discovery.
- `project_id` string, required — The GCP project ID for the project containing the target BigQuery dataset.
- `sourceType` 'bigquery', required
- SourceBingAds
- `account_names` object[] — Predicates that will be used to sync data by specific accounts.
- `name` string, required — Account Name is a string value for comparing with the specified predicate.
- `operator` 'Contains' | 'Equals', required — An Operator that will be used to filter accounts. The Contains predicate has features for matching words, matching inflectional forms of words, searching using wildcard characters, and searching using proximity. The Equals is used to return all rows where account name is equal(=) to the string that you provided
- `auth_method` 'oauth2.0'
- `client_id` string, required — The Client ID of your Microsoft Advertising developer application.
- `client_secret` string — The Client Secret of your Microsoft Advertising developer application.
- `custom_reports` object[] — You can add your Custom Bing Ads report by creating one.
- `disable_custom_report_names_camel_to_snake_conversion` boolean — When enabled, disables the automatic conversion of custom report names from camelCase to snake_case. By default, custom report names are automatically converted (e.g., 'MyCustomReport' becomes 'my_custom_report'). Enable this option if you want to use the exact report names you specify.
- `name` string, required — The name of the custom report, this name would be used as stream name
- `report_aggregation` string, required — A list of available aggregations.
- `report_columns` string[], required — A list of available report object columns. You can find it in description of reporting object that you want to add to custom report.
- `reporting_object` 'AccountPerformanceReportRequest' | 'AdDynamicTextPerformanceReportRequest' | 'AdExtensionByAdReportRequest' | 'AdExtensionByKeywordReportRequest' | 'AdExtensionDetailReportRequest' | 'AdGroupPerformanceReportRequest' | 'AdPerformanceReportRequest' | 'AgeGenderAudienceReportRequest' | 'AudiencePerformanceReportRequest' | 'CallDetailReportRequest' | 'CampaignPerformanceReportRequest' | 'ConversionPerformanceReportRequest' | 'DestinationUrlPerformanceReportRequest' | 'DSAAutoTargetPerformanceReportRequest' | 'DSACategoryPerformanceReportRequest' | 'DSASearchQueryPerformanceReportRequest' | 'GeographicPerformanceReportRequest' | 'GoalsAndFunnelsReportRequest' | 'HotelDimensionPerformanceReportRequest' | 'HotelGroupPerformanceReportRequest' | 'KeywordPerformanceReportRequest' | 'NegativeKeywordConflictReportRequest' | 'ProductDimensionPerformanceReportRequest' | 'ProductMatchCountReportRequest' | 'ProductNegativeKeywordConflictReportRequest' | 'ProductPartitionPerformanceReportRequest' | 'ProductPartitionUnitPerformanceReportRequest' | 'ProductSearchQueryPerformanceReportRequest' | 'ProfessionalDemographicsAudienceReportRequest' | 'PublisherUsagePerformanceReportRequest' | 'SearchCampaignChangeHistoryReportRequest' | 'SearchQueryPerformanceReportRequest' | 'ShareOfVoiceReportRequest' | 'UserLocationPerformanceReportRequest', required — The name of the the object derives from the ReportRequest object. You can find it in Bing Ads Api docs - Reporting API - Reporting Data Objects.
- `developer_token` string, required — Developer token associated with user. See more info in the docs.
- `lookback_window` integer — Also known as attribution or conversion window. How far into the past to look for records (in days). If your conversion window has an hours/minutes granularity, round it up to the number of days exceeding. Used only for performance report streams in incremental mode without specified Reports Start Date.
- `refresh_token` string, required — Refresh Token to renew the expired Access Token.
- `reports_start_date` string, date — The start date from which to begin replicating report data. Any data generated before this date will not be replicated in reports. This is a UTC date in YYYY-MM-DD format. If not set, data from previous and current calendar year will be replicated.
- `tenant_id` string — The Tenant ID of your Microsoft Advertising developer application. Set this to "common" unless you know you need a different value.
- `sourceType` 'bing-ads', required
- SourceBitly
- `api_key` string, required
- `end_date` string, date-time, required
- `start_date` string, date-time, required
- `sourceType` 'bitly', required
- SourceBlogger
- `client_id` string, required
- `client_refresh_token` string, required
- `client_secret` string, required
- `sourceType` 'blogger', required
- SourceBluetally
- `api_key` string, required — Your API key to authenticate with the BlueTally API. You can generate it by navigating to your account settings, selecting 'API Keys', and clicking 'Create API Key'.
- `start_date` string, date-time, required
- `sourceType` 'bluetally', required
- SourceBoldsign
- `api_key` string, required — Your BoldSign API key. You can generate it by navigating to the API menu in the BoldSign app, selecting 'API Key', and clicking 'Generate API Key'. Copy the generated key and paste it here.
- `start_date` string, date-time, required
- `sourceType` 'boldsign', required
- SourceBox
- `client_id` string, required
- `client_secret` string, required
- `user` number, required
- `sourceType` 'box', required
- SourceBraintree
- `environment` 'Development' | 'Sandbox' | 'Qa' | 'Production', required — Environment specifies where the data will come from.
- `merchant_id` string, required — The unique identifier for your entire gateway account. See the docs for more information on how to obtain this ID.
- `private_key` string, required — Braintree Private Key. See the docs for more information on how to obtain this key.
- `public_key` string, required — Braintree Public Key. See the docs for more information on how to obtain this key.
- `start_date` string, date-time — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
- `sourceType` 'braintree', required
- SourceBraze
- `api_key` string, required — Braze REST API key
- `start_date` string, date, required — Rows after this date will be synced
- `url` string, required — Braze REST API endpoint
- `sourceType` 'braze', required
- SourceBreezometer
- `api_key` string, required — Your API Access Key. See here.
- `days_to_forecast` integer — Number of days to forecast. Minimum 1, maximum 3. Valid for Polen and Weather Forecast streams.
- `historic_hours` integer — Number of hours retireve from Air Quality History stream. Minimum 1, maximum 720.
- `hours_to_forecast` integer — Number of hours to forecast. Minimum 1, maximum 96. Valid for Air Quality Forecast stream.
- `latitude` string, required — Latitude of the monitored location.
- `longitude` string, required — Longitude of the monitored location.
- `radius` integer — Desired radius from the location provided. Minimum 5, maximum 100. Valid for Wildfires streams.
- `sourceType` 'breezometer', required
- SourceBreezyHr
- `api_key` string, required
- `company_id` string, required
- `sourceType` 'breezy-hr', required
- SourceBrevo
- `api_key` string, required
- `start_date` string, date-time, required
- `sourceType` 'brevo', required
- SourceBrex
- `start_date` string, date-time, required
- `user_token` string, required — User token to authenticate API requests. Generate it from your Brex dashboard under Developer > Settings.
- `sourceType` 'brex', required
- SourceBugsnag
- `auth_token` string, required — Personal auth token for accessing the Bugsnag API. Generate it in the My Account section of Bugsnag settings.
- `start_date` string, date-time, required
- `sourceType` 'bugsnag', required
- SourceBuildkite
- `api_key` string, required
- `start_date` string, date-time, required
- `sourceType` 'buildkite', required
- SourceBunnyInc
- `apikey` string, required
- `start_date` string, date-time
- `subdomain` string, required — The subdomain specific to your Bunny account or service.
- `sourceType` 'bunny-inc', required
- SourceBuzzsprout
- `api_key` string, required
- `podcast_id` string, required — Podcast ID found in `https://www.buzzsprout.com/my/profile/api`
- `start_date` string, date-time, required
- `sourceType` 'buzzsprout', required
- SourceCalCom
- `api_key` string, required — API key to use. Find it at https://cal.com/account
- `orgId` string, required
- `sourceType` 'cal-com', required
- SourceCalendly
- `api_key` string, required — Go to Integrations → API & Webhooks to obtain your bearer token. https://calendly.com/integrations/api_webhooks
- `lookback_days` number — Number of days to be subtracted from the last cutoff date before starting to sync the `scheduled_events` stream.
- `start_date` string, date-time, required
- `sourceType` 'calendly', required
- SourceCallrail
- `account_id` string, required — Account ID
- `api_key` string, required — API access key
- `start_date` string, required — Start getting data from that date.
- `sourceType` 'callrail', required
- SourceCampaignMonitor
- `password` string
- `start_date` string — Date from when the sync should start
- `username` string, required
- `sourceType` 'campaign-monitor', required
- SourceCampayn
- `api_key` string, required — API key to use. Find it in your Campayn account settings. Keep it secure as it grants access to your Campayn data.
- `sub_domain` string, required
- `sourceType` 'campayn', required
- SourceCanny
- `api_key` string, required — You can find your secret API key in Your Canny Subdomain > Settings > API
- `sourceType` 'canny', required
- SourceCapsuleCrm
- `bearer_token` string, required — Bearer token to authenticate API requests. Generate it from the 'My Preferences' > 'API Authentication Tokens' page in your Capsule account.
- `entity` 'parties' | 'opportunities' | 'kases', required
- `start_date` string, date-time, required
- `sourceType` 'capsule-crm', required
- SourceCaptainData
- `api_key` string, required — Your Captain Data project API key.
- `project_uid` string, required — Your Captain Data project uuid.
- `sourceType` 'captain-data', required
- SourceCareQualityCommission
- `api_key` string, required — Your CQC Primary Key. See https://www.cqc.org.uk/about-us/transparency/using-cqc-data#api for steps to generate one.
- `sourceType` 'care-quality-commission', required
- SourceCart
- `credentials` union
- object
- `auth_type` 'CENTRAL_API_ROUTER', required
- `site_id` string, required — You can determine a site provisioning site Id by hitting https://site.com/store/sitemonitor.aspx and reading the response param PSID
- `user_name` string, required — Enter your application's User Name
- `user_secret` string, required — Enter your application's User Secret
- object
- `access_token` string, required — Access Token for making authenticated requests.
- `auth_type` 'SINGLE_STORE_ACCESS_TOKEN', required
- `store_name` string, required — The name of Cart.com Online Store. All API URLs start with https://[mystorename.com]/api/v1/, where [mystorename.com] is the domain name of your store.
- `start_date` string, required — The date from which you'd like to replicate the data
- `sourceType` 'cart', required
- SourceCastorEdc
- `client_id` string, required — Visit `https://YOUR_REGION.castoredc.com/account/settings`
- `client_secret` string, required — Visit `https://YOUR_REGION.castoredc.com/account/settings`
- `start_date` string, date-time, required
- `url_region` 'uk' | 'nl' | 'us', required — The url region given at time of registration
- `sourceType` 'castor-edc', required
- SourceChameleon
- `api_key` string, required
- `end_date` string, date-time — End date for incremental sync
- `filter` 'tour' | 'survey' | 'launcher' — Filter for using in the `segments_experiences` stream
- `limit` string — Max records per page limit
- `start_date` string, date-time, required
- `sourceType` 'chameleon', required
- SourceChargebee
- `num_workers` integer — The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Chargebee plan. More info about the rate limit plan tiers can be found on Chargebee's API docs.
- `product_catalog` '1.0' | '2.0' — Product Catalog version of your Chargebee site. Instructions on how to find your version you may find here under `API Version` section. If left blank, the product catalog version will be set to 2.0.
- `site` string, required — The site prefix for your Chargebee instance.
- `site_api_key` string, required — Chargebee API Key. See the docs for more information on how to obtain this key.
- `start_date` string, date-time, required — UTC date and time in the format 2017-01-25T00:00:00.000Z. Any data before this date will not be replicated.
- `sourceType` 'chargebee', required
- SourceChargedesk
- `password` string
- `start_date` integer — Date from when the sync should start in epoch Unix timestamp
- `username` string, required
- `sourceType` 'chargedesk', required
- SourceChargify
- `api_key` string, required — Maxio Advanced Billing/Chargify API Key.
- `domain` string, required — Chargify domain. Normally this domain follows the following format
- `password` string
- `username` string, required
- `sourceType` 'chargify', required
- SourceChartmogul
- `api_key` string, required — Your Chartmogul API key. See the docs for info on how to obtain this.
- `start_date` string, date-time, required — UTC date and time in the format 2017-01-25T00:00:00Z. When feasible, any data before this date will not be replicated.
- `sourceType` 'chartmogul', required
- SourceChurnkey
- `api_key` string, required
- `x-ck-app` string, required
- `sourceType` 'churnkey', required
- SourceCimis
- `api_key` string, required
- `daily_data_items` unknown[]
- unknown
- `end_date` string, date-time, required
- `hourly_data_items` unknown[]
- unknown
- `start_date` string, date-time, required
- `targets` unknown[], required
- unknown
- `targets_type` 'WSN station numbers' | 'California zip codes' | 'decimal-degree coordinates' | 'street addresses', required
- `unit_of_measure` 'E' | 'M'
- `sourceType` 'cimis', required
- SourceCin7
- `accountid` string, required — The ID associated with your account.
- `api_key` string, required — The API key associated with your account.
- `sourceType` 'cin7', required
- SourceCirca
- `api_key` string, required — API key to use. Find it at https://app.circa.co/settings/integrations/api
- `start_date` string, date-time, required
- `sourceType` 'circa', required
- SourceCircleci
- `api_key` string, required
- `job_number` string — Job Number of the workflow for `jobs` stream, Auto fetches from `workflow_jobs` stream, if not configured
- `org_id` string, required — The org ID found in `https://app.circleci.com/settings/organization/circleci/xxxxx/overview`
- `project_id` string, required — Project ID found in the project settings, Visit `https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY`
- `start_date` string, date-time, required
- `workflow_id` unknown[] — Workflow ID of a project pipeline, Could be seen in the URL of pipeline build, Example `https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID`
- unknown
- `sourceType` 'circleci', required
- SourceCiscoMeraki
- `api_key` string, required — Your Meraki API key. Obtain it by logging into your Meraki Dashboard at https://dashboard.meraki.com/, navigating to 'My Profile' via the avatar icon in the top right corner, and generating the API key. Save this key securely as it represents your admin credentials.
- `start_date` string, date-time, required
- `sourceType` 'cisco-meraki', required
- SourceClarifAi
- `api_key` string, required
- `start_date` string, date-time, required
- `user_id` string, required — User ID found in settings
- `sourceType` 'clarif-ai', required
- SourceClazar
- `client_id` string, required
- `client_secret` string, required
- `sourceType` 'clazar', required
- SourceClickhouse
- `database` string, required — The name of the database.
- `host` string, required — The host endpoint of the Clickhouse cluster.
- `jdbc_url_params` string — Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters.
- `password` string — The password associated with this username.
- `port` integer, required — The port of the database.
- `ssl` boolean — Encrypt data using SSL.
- `tunnel_method` union — Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
- object
- `tunnel_method` 'NO_TUNNEL', required — No ssh tunnel needed to connect to database
- object
- `ssh_key` string, required — OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
- `tunnel_host` string, required — Hostname of the jump server host that allows inbound ssh tunnel.
- `tunnel_method` 'SSH_KEY_AUTH', required — Connect through a jump server tunnel host using username and ssh key
- `tunnel_port` integer, required — Port on the proxy/jump server that accepts inbound ssh connections.
- `tunnel_user` string, required — OS-level username for logging into the jump server host.
- object
- `tunnel_host` string, required — Hostname of the jump server host that allows inbound ssh tunnel.
- `tunnel_method` 'SSH_PASSWORD_AUTH', required — Connect through a jump server tunnel host using username and password authentication
- `tunnel_port` integer, required — Port on the proxy/jump server that accepts inbound ssh connections.
- `tunnel_user` string, required — OS-level username for logging into the jump server host
- `tunnel_user_password` string, required — OS-level password for logging into the jump server host
- `username` string, required — The username which is used to access the database.
- `sourceType` 'clickhouse', required
- SourceClickupApi
- `api_token` string, required — Every ClickUp API call required authentication. This field is your personal API token. See here.
- `include_closed_tasks` boolean — Include or exclude closed tasks. By default, they are excluded. See here.
- `sourceType` 'clickup-api', required
- SourceClockify
- `api_key` string, required — You can get your api access_key here This API is Case Sensitive.
- `api_url` string — The URL for the Clockify API. This should only need to be modified if connecting to an enterprise version of Clockify.
- `workspace_id` string, required — WorkSpace Id
- `sourceType` 'clockify', required
- SourceClockodo
- `api_key` string, required — API key to use. Find it in the 'Personal data' section of your Clockodo account.
- `email_address` string, required — Your Clockodo account email address. Find it in your Clockodo account settings.
- `external_application` string, required — Identification of the calling application, including the email address of a technical contact person. Format: [name of application or company];[email address].
- `start_date` string, date-time, required
- `years` unknown[], required — 2024, 2025
- unknown
- `sourceType` 'clockodo', required
- SourceCloseCom
- `api_key` string, required — Close.com API key (usually starts with 'api_'; find yours here).
- `start_date` string, date — The start date to sync data; all data after this date will be replicated. Leave blank to retrieve all the data available in the account. Format: YYYY-MM-DD.
- `sourceType` 'close-com', required
- SourceCloudbeds
- `api_key` string, required
- `sourceType` 'cloudbeds', required
- SourceCoassemble
- `user_id` string, required
- `user_token` string, required
- `sourceType` 'coassemble', required
- SourceCoda
- `auth_token` string, required — Bearer token
- `sourceType` 'coda', required
- SourceCodefresh
- `account_id` string, required
- `api_key` string, required
- `report_date_range` unknown[]
- unknown
- `report_granularity` string
- `start_date` string, date-time, required
- `sourceType` 'codefresh', required
- SourceCoinApi
- `api_key` string, required — API Key
- `end_date` string — The end date in ISO 8601 format. If not supplied, data will be returned from the start date to the current time, or when the count of result elements reaches its limit.
- `environment` 'sandbox' | 'production', required — The environment to use. Either sandbox or production.
- `limit` integer — The maximum number of elements to return. If not supplied, the default is 100. For numbers larger than 100, each 100 items is counted as one request for pricing purposes. Maximum value is 100000.
- `period` string, required — The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get
- `start_date` string, required — The start date in ISO 8601 format.
- `symbol_id` string, required — The symbol ID to use. See the documentation for a list. https://docs.coinapi.io/#list-all-symbols-get
- `sourceType` 'coin-api', required
- SourceCoingeckoCoins
- `api_key` string — API Key (for pro users)
- `coin_id` string, required — CoinGecko coin ID (e.g. bitcoin). Can be retrieved from the `/coins/list` endpoint.
- `days` '1' | '7' | '14' | '30' | '90' | '180' | '365' | 'max', required — The number of days of data for market chart.
- `end_date` string, date — The end date for the historical data stream in dd-mm-yyyy format.
- `start_date` string, date, required — The start date for the historical data stream in dd-mm-yyyy format.
- `vs_currency` string, required — The target currency of market data (e.g. usd, eur, jpy, etc.)
- `sourceType` 'coingecko-coins', required
- SourceCoinmarketcap
- `api_key` string, required — Your API Key. See here. The token is case sensitive.
- `data_type` 'latest' | 'historical', required — /latest: Latest market ticker quotes and averages for cryptocurrencies and exchanges. /historical: Intervals of historic market data like OHLCV data or data for use in charting libraries. See here.
- `symbols` string[] — Cryptocurrency symbols. (only used for quotes stream)
- `sourceType` 'coinmarketcap', required
- SourceConcord
- `api_key` string, required
- `env` 'uat' | 'api', required — The environment from where you want to access the API.
- `sourceType` 'concord', required
- SourceConfigcat
- `password` string, required — Basic auth password. See here.
- `username` string, required — Basic auth user name. See here.
- `sourceType` 'configcat', required
- SourceConfluence
- `api_token` string, required — Please follow the Jira confluence for generating an API token: generating an API token.
- `domain_name` string, required — Your Confluence domain name
- `email` string, required — Your Confluence login email
- `sourceType` 'confluence', required
- SourceConvertkit
- `credentials` union, required
- object
- `access_token` string — An access token generated using the provided client information and refresh token.
- `auth_type` 'oauth2.0', required
- `client_id` string, required — The client ID of your OAuth application.
- `client_secret` string, required — The client secret of your OAuth application.
- `expires_at` string, date-time — The time at which the current access token is set to expire
- `refresh_token` string, required — A current, non-expired refresh token genereted using the provided client ID and secret.
- object
- `api_key` string, required — Kit/ConvertKit API Key
- `auth_type` 'api_key', required
- `start_date` string, date-time, required
- `sourceType` 'convertkit', required
- SourceConvex
- `access_key` string, required — API access key used to retrieve data from Convex.
- `deployment_url` string, required
- `sourceType` 'convex', required
- SourceCopper
- `api_key` string, required — Copper API key
- `user_email` string, required — user email used to login in to Copper
- `sourceType` 'copper', required
- SourceCouchbase
- `bucket` string, required — The name of the bucket to sync data from
- `connection_string` string, required — The connection string for the Couchbase server (e.g., couchbase://localhost or couchbases://example.com)
- `password` string, required — The password to use for authentication
- `start_date` string, date-time — The date from which you'd like to replicate data for incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If not set, all data will be replicated.
- `username` string, required — The username to use for authentication
- `sourceType` 'couchbase', required
- SourceCountercyclical
- `api_key` string, required
- `sourceType` 'countercyclical', required
- SourceCustomerIo
- `app_api_key` string, required
- `sourceType` 'customer-io', required
- SourceCustomerly
- `api_key` string, required
- `sourceType` 'customerly', required
- SourceDatadog
- `api_key` string, required — Datadog API key
- `application_key` string, required — Datadog application key
- `end_date` string — UTC date and time in the format 2017-01-25T00:00:00Z. Data after this date will not be replicated. An empty value will represent the current datetime for each execution. This just applies to Incremental syncs.
- `max_records_per_request` integer — Maximum number of records to collect per request.
- `queries` object[] — List of queries to be run and used as inputs.
- `data_source` 'metrics' | 'cloud_cost' | 'logs' | 'rum', required — A data source that is powered by the platform.
- `name` string, required — The variable name for use in queries.
- `query` string, required — A classic query string.
- `query` string — The search query. This just applies to Incremental syncs. If empty, it'll collect all logs.
- `site` 'datadoghq.com' | 'us3.datadoghq.com' | 'us5.datadoghq.com' | 'datadoghq.eu' | 'ddog-gov.com' — The site where Datadog data resides in.
- `start_date` string — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This just applies to Incremental syncs.
- `sourceType` 'datadog', required
- SourceDatagen
- `concurrency` integer — Maximum number of concurrent data generators. Leave empty to let Airbyte optimize performance.
- `flavor` union, required — Different patterns for generating data
- object — Generates incrementally increasing numerical data for the source.
- `data_type` 'increment', required
- object — Generates one column of each Airbyte data type.
- `data_type` 'types', required
- `max_records` integer, required — The number of record messages to emit from this connector. Min 1. Max 100 billion.
- `sourceType` 'datagen', required
- SourceDatascope
- `api_key` string, required — API Key
- `start_date` string, required — Start date for the data to be replicated
- `sourceType` 'datascope', required
- SourceDb2Enterprise
- `check_privileges` boolean — When this feature is enabled, during schema discovery the connector will query each table or view individually to check access privileges and inaccessible tables, views, or columns therein will be removed. In large schemas, this might cause schema discovery to take too long, in which case it might be advisable to disable this feature.
- `checkpoint_target_interval_seconds` integer — How often (in seconds) a stream should checkpoint, when possible.
- `concurrency` integer — Maximum number of concurrent queries to the database.
- `cursor` union, required — Configures how data is extracted from the database.
- object — Incrementally detects new inserts and updates using the cursor column chosen when configuring a connection (e.g. created_at, updated_at).
- `cursor_method` 'user_defined', required
- object — Recommended - Incrementally reads new inserts, updates, and deletes using change data capture feature. This must be enabled on your database.
- `cursor_method` 'cdc', required
- `initial_load_timeout_hours` integer — The amount of time an initial load is allowed to continue for before catching up on CDC events.
- `database` string, required — The database name.
- `encryption` union, required — The encryption method with is used when communicating with the database.
- object — Data transfer will not be encrypted.
- `encryption_method` 'unencrypted', required
- object — Verify and use the certificate provided by the server.
- `encryption_method` 'encrypted_verify_certificate', required
- `ssl_certificate` string, required — Privacy Enhanced Mail (PEM) files are concatenated certificate containers frequently used in certificate installations.
- `host` string, required — Hostname of the database.
- `jdbc_url_params` string — Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
- `password` string — The password associated with the username.
- `port` integer, required — Port of the database.
- `schemas` string[], required — The list of schemas to sync from.
- `tunnel_method` union, required — Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
- object — No ssh tunnel needed to connect to database
- `tunnel_method` 'NO_TUNNEL', required
- object — Connect through a jump server tunnel host using username and ssh key
- `ssh_key` string, required — OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
- `tunnel_host` string, required — Hostname of the jump server host that allows inbound ssh tunnel.
- `tunnel_method` 'SSH_KEY_AUTH', required
- `tunnel_port` integer, required — Port on the proxy/jump server that accepts inbound ssh connections.
- `tunnel_user` string, required — OS-level username for logging into the jump server host
- object — Connect through a jump server tunnel host using username and password authentication
- `tunnel_host` string, required — Hostname of the jump server host that allows inbound ssh tunnel.
- `tunnel_method` 'SSH_PASSWORD_AUTH', required
- `tunnel_port` integer, required — Port on the proxy/jump server that accepts inbound ssh connections.
- `tunnel_user` string, required — OS-level username for logging into the jump server host
- `tunnel_user_password` string, required — OS-level password for logging into the jump server host
- `username` string, required — The username which is used to access the database.
- `sourceType` 'db2-enterprise', required
- SourceDbt
- `account_id` string, required
- `api_key_2` string, required
- `sourceType` 'dbt', required
- SourceDefillama
- `sourceType` 'defillama'
- SourceDelighted
- `api_key` string, required — A Delighted API key.
- `since` string, date-time, required — The date from which you'd like to replicate the data
- `sourceType` 'delighted', required
- SourceDeputy
- `api_key` string, required
- `base_url` string, required — The base url for your deputy account to make API requests
- `sourceType` 'deputy', required
- SourceDingConnect
- `X-Correlation-Id` string — Optional header to correlate HTTP requests between a client and server.
- `api_key` string, required — Your API key for authenticating with the DingConnect API. You can generate this key by navigating to the Developer tab in the Account Settings section of your DingConnect account.
- `start_date` string, date-time, required
- `sourceType` 'ding-connect', required
- SourceDixa
- `api_token` string, required — Dixa API token
- `batch_size` integer — Number of days to batch into one request. Max 31.
- `start_date` string, date-time, required — The connector pulls records updated from this date onwards.
- `sourceType` 'dixa', required
- SourceDockerhub
- `docker_username` string, required — Username of DockerHub person or organization (for https://hub.docker.com/v2/repositories/USERNAME/ API call)
- `sourceType` 'dockerhub', required
- SourceDocuseal
- `api_key` string, required — Your API key for authenticating with the DocuSeal API. Obtain it from the DocuSeal API Console at https://console.docuseal.com/api.
- `limit` string — The pagination limit
- `start_date` string, date-time, required
- `sourceType` 'docuseal', required
- SourceDolibarr
- `api_key` string, required
- `my_dolibarr_domain_url` string, required — enter your "domain/dolibarr_url" without https:// Example: mydomain.com/dolibarr
- `start_date` string, date-time, required
- `sourceType` 'dolibarr', required
- SourceDremio
- `api_key` string, required — API Key that is generated when you authenticate to Dremio API
- `base_url` string, required — URL of your Dremio instance
- `sourceType` 'dremio', required
- SourceDrift
- `credentials` union
- object
- `access_token` string, required — Access Token for making authenticated requests.
- `client_id` string, required — The Client ID of your Drift developer application.
- `client_secret` string, required — The Client Secret of your Drift developer application.
- `credentials` 'oauth2.0'
- `refresh_token` string, required — Refresh Token to renew the expired Access Token.
- object
- `access_token` string, required — Drift Access Token. See the docs for more information on how to generate this key.
- `credentials` 'access_token'
- `email` string — Email used as parameter for contacts stream
- `sourceType` 'drift', required
- SourceDrip
- `api_key` string, required — API key to use. Find it at https://www.getdrip.com/user/edit
- `sourceType` 'drip', required
- SourceDropboxSign
- `api_key` string, required — API key to use. Find it at https://app.hellosign.com/home/myAccount#api
- `start_date` string, date-time, required
- `sourceType` 'dropbox-sign', required
- SourceDwolla
- `client_id` string, required
- `client_secret` string, required
- `environment` 'api' | 'api-sandbox', required — The environment for the Dwolla API, either 'api-sandbox' or 'api'.
- `start_date` string, date-time, required
- `sourceType` 'dwolla', required
- SourceDynamodb
- `credentials` object — Credentials for the service
- `auth_type` 'Role'
- `endpoint` string — the URL of the Dynamodb database
- `ignore_missing_read_permissions_tables` boolean — Ignore tables with missing scan/read permissions
- `region` '' | 'af-south-1' | 'ap-east-1' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-south-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-southeast-3' | 'ap-southeast-4' | 'ca-central-1' | 'ca-west-1' | 'cn-north-1' | 'cn-northwest-1' | 'eu-central-1' | 'eu-central-2' | 'eu-north-1' | 'eu-south-1' | 'eu-south-2' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'il-central-1' | 'me-central-1' | 'me-south-1' | 'sa-east-1' | 'us-east-1' | 'us-east-2' | 'us-gov-east-1' | 'us-gov-west-1' | 'us-west-1' | 'us-west-2' — The region of the Dynamodb database
- `reserved_attribute_names` string — Comma separated reserved attribute names present in your tables
- `sourceType` 'dynamodb'
- SourceEConomic
- `agreement_grant_token` string, required — Token that identifies the grant issued by an agreement, allowing your app to access data. Obtain it from your e-conomic account settings.
- `app_secret_token` string, required — Your private token that identifies your app. Find it in your e-conomic account settings.
- `sourceType` 'e-conomic', required
- SourceEasypost
- `start_date` string, date-time, required
- `username` string, required — The API Key from your easypost settings
- `sourceType` 'easypost', required
- SourceEasypromos
- `bearer_token` string, required
- `sourceType` 'easypromos', required
- SourceEbayFinance
- `api_host` 'https://apiz.sandbox.ebay.com' | 'https://apiz.ebay.com', required — https://apiz.sandbox.ebay.com for sandbox & https://apiz.ebay.com for production
- `password` string — Ebay Client Secret
- `redirect_uri` string, required
- `refresh_token` string, required
- `start_date` string, date-time, required
- `token_refresh_endpoint` 'https://api.sandbox.ebay.com/identity/v1/oauth2/token' | 'https://api.ebay.com/identity/v1/oauth2/token', required
- `username` string, required — Ebay Developer Client ID
- `sourceType` 'ebay-finance', required
- SourceEbayFulfillment
- `api_host` 'https://api.ebay.com' | 'https://api.sandbox.ebay.com', required
- `password` string, required
- `redirect_uri` string, required
- `refresh_token` string, required
- `refresh_token_endpoint` 'https://api.ebay.com/identity/v1/oauth2/token' | 'https://api.sandbox.ebay.com/identity/v1/oauth2/token', required
- `start_date` string, date-time, required
- `username` string, required
- `sourceType` 'ebay-fulfillment', required
- SourceElasticemail
- `api_key` string, required
- `from` string, date-time
- `scope_type` 'Personal' | 'Global'
- `start_date` string, date-time, required
- `sourceType` 'elasticemail', required
- SourceElasticsearch
- `authenticationMethod` union — The type of authentication to be used
- object — No authentication will be used
- `method` 'none', required
- object — Use a api key and secret combination to authenticate
- `apiKeyId` string, required — The Key ID to used when accessing an enterprise Elasticsearch instance.
- `apiKeySecret` string, required — The secret associated with the API Key ID.
- `method` 'secret', required
- object — Basic auth header with a username and password
- `method` 'basic', required
- `password` string, required — Basic auth password to access a secure Elasticsearch server
- `username` string, required — Basic auth username to access a secure Elasticsearch server
- `endpoint` string, required — The full url of the Elasticsearch server
- `sourceType` 'elasticsearch', required
- SourceEmailoctopus
- `api_key` string, required — EmailOctopus API Key. See the docs for information on how to generate this key.
- `sourceType` 'emailoctopus', required
- SourceEmploymentHero
- `api_key` string, required
- `employees_configids` unknown[] — Employees IDs in the given organisation found in `employees` stream for passing to sub-streams
- unknown
- `organization_configids` unknown[] — Organization ID which could be found as result of `organizations` stream to be used in other substreams
- unknown
- `sourceType` 'employment-hero', required
- SourceEncharge
- `api_key` string, required — The API key to use for authentication
- `sourceType` 'encharge', required
- SourceEventbrite
- `private_token` string, required — The private token to use for authenticating API requests.
- `start_date` string, date-time, required
- `sourceType` 'eventbrite', required
- SourceEventee
- `api_token` string, required — API token to use. Generate it at https://admin.eventee.co/ in 'Settings -> Features'.
- `sourceType` 'eventee', required
- SourceEventzilla
- `x-api-key` string, required — API key to use. Generate it by creating a new application within your Eventzilla account settings under Settings > App Management.
- `sourceType` 'eventzilla', required
- SourceEverhour
- `api_key` string, required — Everhour API Key. See the docs for information on how to generate this key.
- `sourceType` 'everhour', required
- SourceExchangeRates
- `access_key` string, required — Your API Key. See here. The key is case sensitive.
- `base` string — ISO reference currency. See here. Free plan doesn't support Source Currency Switching, default base currency is EUR
- `ignore_weekends` boolean — Ignore weekends? (Exchanges don't run on weekends)
- `start_date` string, date, required — Start getting data from that date.
- `sourceType` 'exchange-rates', required
- SourceEzofficeinventory
- `api_key` string, required — Your EZOfficeInventory Access Token. API Access is disabled by default. Enable API Access in Settings > Integrations > API Integration and click on Update to generate a new access token
- `start_date` string, date-time, required — Earliest date you want to sync historical streams (inventory_histories, asset_histories, asset_stock_histories) from
- `subdomain` string, required — The company name used in signup, also visible in the URL when logged in.
- `sourceType` 'ezofficeinventory', required
- SourceFacebookMarketing
- `access_token` string — The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions ads_management, ads_read, read_insights, business_management. Then click on "Get token". See the docs for more information.
- `account_ids` string[], required — The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your Meta Ads Manager. See the docs for more information.
- `ad_statuses` string[] — Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.
- `adset_statuses` string[] — Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.
- `campaign_statuses` string[] — Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.
- `credentials` union, required — Credentials for connecting to the Facebook Marketing API
- object
- `access_token` string — The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions ads_management, ads_read, read_insights, business_management. Then click on "Get token". See the docs for more information.
- `auth_type` 'Client', required
- `client_id` string, required — Client ID for the Facebook Marketing API
- `client_secret` string, required — Client Secret for the Facebook Marketing API
- object
- `access_token` string, required — The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions ads_management, ads_read, read_insights, business_management. Then click on "Get token". See the docs for more information.
- `auth_type` 'Service', required
- `custom_insights` object[] — A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action_breakdowns. Click on "add" to fill this field.
- `action_breakdowns` string[] — A list of chosen action_breakdowns for action_breakdowns
- `breakdowns` string[] — A list of chosen breakdowns for breakdowns
- `end_date` string, date-time — The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.
- `fields` string[] — A list of chosen fields for fields parameter
- `insights_job_timeout` integer — The insights job timeout
- `insights_lookback_window` integer — The attribution window
- `level` 'ad' | 'adset' | 'campaign' | 'account' — Chosen level for API
- `name` string, required — The name value of insight
- `start_date` string, date-time — The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.
- `time_increment` integer — Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only). The minimum allowed value for this field is 1, and the maximum is 89.
- `default_ads_insights_action_breakdowns` string[] — Action breakdowns for the Built-in Ads Insights stream that will be used in the request. You can override default values or remove them to make it empty if needed.
- `end_date` string, date-time — The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.
- `fetch_thumbnail_images` boolean — Set to active if you want to fetch the thumbnail_url and store the result in thumbnail_data_url for each Ad Creative.
- `insights_job_timeout` integer — Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster.
- `insights_lookback_window` integer — The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here.
- `page_size` integer — Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases.
- `start_date` string, date-time — The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. If not set then all data will be replicated for usual streams and only last 2 years for insight streams.
- `sourceType` 'facebook-marketing', required
- SourceFacebookPages
- `access_token` string, required — Facebook Page Access Token
- `page_id` string, required — Page ID
- `sourceType` 'facebook-pages', required
- SourceFactorial
- `api_key` string, required
- `limit` string — Max records per page limit
- `start_date` string, date-time, required
- `sourceType` 'factorial', required
- SourceFaker
- `always_updated` boolean — Should the updated_at values for every record be new each sync? Setting this to false will case the source to stop emitting records after COUNT records have been emitted.
- `count` integer — How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream.
- `parallelism` integer — How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source.
- `records_per_slice` integer — How many fake records will be in each page (stream slice), before a state message is emitted?
- `seed` integer — Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random)
- `sourceType` 'faker', required
- SourceFastbill
- `api_key` string, required — Fastbill API key
- `username` string, required — Username for Fastbill account
- `sourceType` 'fastbill', required
- SourceFastly
- `fastly_api_token` string, required — Your Fastly API token. You can generate this token in the Fastly web interface under Account Settings or via the Fastly API. Ensure the token has the appropriate scope for your use case.
- `start_date` string, date-time, required
- `sourceType` 'fastly', required
- SourceFauna
- `collection` object — Settings for the Fauna Collection.
- `deletions` union, required — This only applies to incremental syncs.
Enabling deletion mode informs your destination of deleted documents.
Disabled - Leave this feature disabled, and ignore deleted documents.
Enabled - Enables this feature. When a document is deleted, the connector exports a record with a "deleted at" column containing the time that the document was deleted.
- object
- …
- object
- …
- `page_size` integer, required — The page size used when reading documents from the database. The larger the page size, the faster the connector processes documents. However, if a page is too large, the connector may fail.
Choose your page size based on how large the documents are.
See the docs.
- `domain` string, required — Domain of Fauna to query. Defaults db.fauna.com. See the docs.
- `port` integer, required — Endpoint port.
- `scheme` string, required — URL scheme.
- `secret` string, required — Fauna secret, used when authenticating with the database.
- `sourceType` 'fauna', required
- SourceFile
- `dataset_name` string, required — The Name of the final table to replicate this file into (should include letters, numbers dash and underscores only).
- `format` 'csv' | 'json' | 'jsonl' | 'excel' | 'excel_binary' | 'fwf' | 'feather' | 'parquet' | 'yaml', required — The Format of the file which should be replicated (Warning: some formats may be experimental, please refer to the docs).
- `provider` union, required — The storage Provider or Location of the file(s) which should be replicated.
- object
- `storage` 'HTTPS', required
- `user_agent` boolean — Add User-Agent to request
- object
- `service_account_json` string — In order to access private Buckets stored on Google Cloud, this connector would need a service account json credentials with the proper permissions as described here. Please generate the credentials.json file and copy/paste its content to this field (expecting JSON formats). If accessing publicly available data, this field is not necessary.
- `storage` 'GCS', required
- object
- `aws_access_key_id` string — In order to access private Buckets stored on AWS S3, this connector would need credentials with the proper permissions. If accessing publicly available data, this field is not necessary.
- `aws_secret_access_key` string — In order to access private Buckets stored on AWS S3, this connector would need credentials with the proper permissions. If accessing publicly available data, this field is not necessary.
- `storage` 'S3', required
- object
- `sas_token` string — To access Azure Blob Storage, this connector would need credentials with the proper permissions. One option is a SAS (Shared Access Signature) token. If accessing publicly available data, this field is not necessary.
- `shared_key` string — To access Azure Blob Storage, this connector would need credentials with the proper permissions. One option is a storage account shared key (aka account key or access key). If accessing publicly available data, this field is not necessary.
- `storage` 'AzBlob', required
- `storage_account` string, required — The globally unique name of the storage account that the desired blob sits within. See here for more details.
- object
- `host` string, required
- `password` string
- `port` string
- `storage` 'SSH', required
- `user` string, required
- object
- `host` string, required
- `password` string
- `port` string
- `storage` 'SCP', required
- `user` string, required
- object
- `host` string, required
- `password` string
- `port` string
- `storage` 'SFTP', required
- `user` string, required
- object
- `storage` 'local', required — WARNING: Note that the local storage URL available for reading must start with the local mount "/local/" at the moment until we implement more advanced docker mounting options.
- `reader_options` string — This should be a string in JSON format. It depends on the chosen file format to provide additional options and tune its behavior.
- `url` string, required — The URL path to access the file which should be replicated.
- `sourceType` 'file', required
- SourceFillout
- `api_key` string, required — API key to use. Find it in the Developer settings tab of your Fillout account.
- `start_date` string, date-time, required
- `sourceType` 'fillout', required
- SourceFinage
- `api_key` string, required
- `period` string — Time period. Default is 10
- `start_date` string, date-time, required
- `symbols` unknown[], required — List of symbols
- unknown
- `tech_indicator_type` 'DEMA' | 'EMA' | 'SMA' | 'WMA' | 'RSI' | 'TEMA' | 'Williams' | 'ADX' — One of DEMA, EMA, SMA, WMA, RSI, TEMA, Williams, ADX
- `time` 'daily' | '1min' | '5min' | '15min' | '30min' | '1hour' | '4hour'
- `time_aggregates` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' — Size of the time
- `time_period` 'annual' | 'quarter' — Time Period for cash flow stmts
- `sourceType` 'finage', required
- SourceFinancialModelling
- `api_key` string, required
- `exchange` string — The stock exchange : AMEX, AMS, AQS, ASX, ATH, BER, BME, BRU, BSE, BUD, BUE, BVC, CAI, CBOE, CNQ, CPH, DFM, DOH, DUS, DXE, EGX, EURONEXT, HAM, HEL, HKSE, ICE, IOB, IST, JKT, JNB, JPX, KLS, KOE, KSC, KUW, LSE, MCX, MEX, MIL, MUN, NASDAQ, NEO, NSE, NYSE, NZE, OEM, OQX, OSL, OTC, PNK, PRA, RIS, SAO, SAU, SES, SET, SGO, SHH, SHZ, SIX, STO, STU, TAI, TLV, TSX, TSXV, TWO, VIE, VSE, WSE, XETRA
- `marketcaplowerthan` string — Used in screener to filter out stocks with a market cap lower than the give marketcap
- `marketcapmorethan` string — Used in screener to filter out stocks with a market cap more than the give marketcap
- `start_date` string, date-time, required
- `time_frame` '1min' | '5min' | '15min' | '30min' | '1hour' | '4hour' — For example 1min, 5min, 15min, 30min, 1hour, 4hour
- `sourceType` 'financial-modelling', required
- SourceFinnhub
- `api_key` string, required — The API key to use for authentication
- `exchange` string, required — More info: https://finnhub.io/docs/api/stock-symbols
- `market_news_category` 'general' | 'forex' | 'crypto' | 'merger', required — This parameter can be 1 of the following values general, forex, crypto, merger.
- `start_date_2` string, date-time, required
- `symbols` unknown[], required
- unknown
- `sourceType` 'finnhub', required
- SourceFinnworlds
- `bond_type` unknown[] — For example 10y, 5y, 2y...
- unknown
- `commodities` unknown[] — Options Available: beef, cheese, oil, ...
- unknown
- `countries` unknown[] — brazil, united states, italia, japan
- unknown
- `key` string, required
- `list` string — Choose isin, ticker, reg_lei or cik
- `list_countries_for_bonds` string
- `start_date` string, date-time, required
- `tickers` unknown[] — AAPL, T, MU, GOOG
- unknown
- `sourceType` 'finnworlds', required
- SourceFirebolt
- `account` string, required — Firebolt account to login.
- `client_id` string, required — Firebolt service account ID.
- `client_secret` string, required — Firebolt secret, corresponding to the service account ID.
- `database` string, required — The database to connect to.
- `engine` string, required — Engine name to connect to.
- `host` string — The host name of your Firebolt database.
- `sourceType` 'firebolt', required
- SourceFirehydrant
- `api_token` string, required — Bot token to use for authenticating with the FireHydrant API. You can find or create a bot token by logging into your organization and visiting the Bot users page at https://app.firehydrant.io/organizations/bots.
- `sourceType` 'firehydrant', required
- SourceFleetio
- `account_token` string, required
- `api_key` string, required
- `sourceType` 'fleetio', required
- SourceFlexmail
- `account_id` string, required — Your Flexmail account ID. You can find it in your Flexmail account settings.
- `personal_access_token` string, required — A personal access token for API authentication. Manage your tokens in Flexmail under Settings > API > Personal access tokens.
- `sourceType` 'flexmail', required
- SourceFlexport
- `api_key` string, required
- `start_date` string, date-time, required
- `sourceType` 'flexport', required
- SourceFloat
- `access_token` string, required — API token obtained from your Float Account Settings page
- `start_date` string, date-time, required
- `sourceType` 'float', required
- SourceFlowlu
- `api_key` string, required — The API key to use for authentication
- `company` string, required
- `sourceType` 'flowlu', required
- SourceFormbricks
- `api_key` string, required — API key to use. You can generate and find it in your Postman account settings.
- `sourceType` 'formbricks', required
- SourceFreeAgentConnector
- `client_id` string, required
- `client_refresh_token_2` string, required
- `client_secret` string, required
- `payroll_year` number
- `updated_since` string, date-time
- `sourceType` 'free-agent-connector', required
- SourceFreightview
- `client_id` string, required
- `client_secret` string, required
- `sourceType` 'freightview', required
- SourceFreshbooks
- `account_id` string, required
- `business_uuid` string, required
- `client_id` string, required
- `client_refresh_token` string, required
- `client_secret` string, required
- `oauth_access_token` string — The current access token. This field might be overridden by the connector based on the token refresh endpoint response.
- `oauth_token_expiry_date` string, date-time — The date the current access token expires in. This field might be overridden by the connector based on the token refresh endpoint response.
- `redirect_uri` string, required
- `sourceType` 'freshbooks', required
- SourceFreshcaller
- `api_key` string, required — Freshcaller API Key. See the docs for more information on how to obtain this key.
- `domain` string, required — Used to construct Base URL for the Freshcaller APIs
- `requests_per_minute` integer — The number of requests per minute that this source allowed to use. There is a rate limit of 50 requests per minute per app per account.
- `start_date` string, date-time — UTC date and time. Any data created after this date will be replicated.
- `sync_lag_minutes` integer — Lag in minutes for each sync, i.e., at time T, data for the time range [prev_sync_time, T-30] will be fetched
- `sourceType` 'freshcaller', required
- SourceFreshchat
- `account_name` string, required — The unique account name for your Freshchat instance
- `api_key` string, required
- `start_date` string, date-time, required
- `sourceType` 'freshchat', required
- SourceFreshdesk
- `api_key` string, required — Freshdesk API Key. See the docs for more information on how to obtain this key.
- `domain` string, required — Freshdesk domain
- `lookback_window_in_days` integer — Number of days for lookback window for the stream Satisfaction Ratings
- `rate_limit_plan` union — Rate Limit Plan for API Budget
- object
- `contacts_rate_limit` 50 — Maximum Rate in Limit/minute for contacts list endpoint in Free Plan
- `general_rate_limit` 50 — General Maximum Rate in Limit/minute for other endpoints in Free Plan
- `plan_type` 'free'
- `tickets_rate_limit` 50 — Maximum Rate in Limit/minute for tickets list endpoint in Free Plan
- object
- `contacts_rate_limit` 20 — Maximum Rate in Limit/minute for contacts list endpoint in Growth Plan
- `general_rate_limit` 200 — General Maximum Rate in Limit/minute for other endpoints in Growth Plan
- `plan_type` 'growth'
- `tickets_rate_limit` 20 — Maximum Rate in Limit/minute for tickets list endpoint in Growth Plan
- object
- `contacts_rate_limit` 100 — Maximum Rate in Limit/minute for contacts list endpoint in Pro Plan
- `general_rate_limit` 400 — General Maximum Rate in Limit/minute for other endpoints in Pro Plan
- `plan_type` 'pro'
- `tickets_rate_limit` 100 — Maximum Rate in Limit/minute for tickets list endpoint in Pro Plan
- object
- `contacts_rate_limit` 200 — Maximum Rate in Limit/minute for contacts list endpoint in Enterprise Plan
- `general_rate_limit` 700 — General Maximum Rate in Limit/minute for other endpoints in Enterprise Plan
- `plan_type` 'enterprise'
- `tickets_rate_limit` 200 — Maximum Rate in Limit/minute for tickets list endpoint in Enterprise Plan
- object
- `contacts_rate_limit` integer — Maximum Rate in Limit/minute for contacts list endpoint in Custom Plan
- `general_rate_limit` integer — General Maximum Rate in Limit/minute for other endpoints in Custom Plan
- `plan_type` 'custom'
- `tickets_rate_limit` integer — Maximum Rate in Limit/minute for tickets list endpoint in Custom Plan
- `requests_per_minute` integer — The number of requests per minute that this source allowed to use. There is a rate limit of 50 requests per minute per app per account.
- `start_date` string, date-time — UTC date and time. Any data created after this date will be replicated. If this parameter is not set, all data will be replicated.
- `sourceType` 'freshdesk', required
- SourceFreshsales
- `api_key` string, required — Freshsales API Key. See here. The key is case sensitive.
- `domain_name` string, required — The Name of your Freshsales domain
- `sourceType` 'freshsales', required
- SourceFreshservice
- `api_key` string, required — Freshservice API Key. See here. The key is case sensitive.
- `domain_name` string, required — The name of your Freshservice domain
- `start_date` string, date-time, required — UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated.
- `sourceType` 'freshservice', required
- SourceFront
- `api_key` string, required
- `page_limit` string — Page limit for the responses
- `start_date` string, date-time, required
- `sourceType` 'front', required
- SourceFulcrum
- `api_key` string, required — API key to use. Find it at https://web.fulcrumapp.com/settings/api
- `sourceType` 'fulcrum', required
- SourceFullstory
- `api_key` string, required — API Key for the fullstory.com API.
- `uid` string, required — User ID for the fullstory.com API.
- `sourceType` 'fullstory', required
- SourceGainsightPx
- `api_key` string, required — The Aptrinsic API Key which is recieved from the dashboard settings (ref - https://app.aptrinsic.com/settings/api-keys)
- `sourceType` 'gainsight-px', required
- SourceGcs — NOTE: When this Spec is changed, legacy_config_transformer.py must also be modified to uptake the changes because it is responsible for converting legacy GCS configs into file based configs using the File-Based CDK.
- `bucket` string, required — Name of the GCS bucket where the file(s) exist.
- `credentials` union, required — Credentials for connecting to the Google Cloud Storage API
- object
- `access_token` string, required — Access Token
- `auth_type` 'Client'
- `client_id` string, required — Client ID
- `client_secret` string, required — Client Secret
- `refresh_token` string, required — Access Token
- object
- `auth_type` 'Service'
- `service_account` string, required — Enter your Google Cloud service account key in JSON format
- `start_date` string, date-time — UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated.
- `streams` object[], required — Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table.
- `days_to_sync_if_history_is_full` integer — When the state history of the file store is full, syncs will only read files that were last modified in the provided day range.
- `format` union, required — The configuration options that are used to alter how to read incoming files that deviate from the standard formatting.
- object
- …
- object
- …
- object
- …
- object
- …
- object — Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one record per file.
- …
- object
- …
- `globs` string[] — The pattern used to specify which files should be selected from the file system. For more information on glob pattern matching look here.
- `input_schema` string — The schema that will be used to validate records extracted from the file. This will override the stream schema that is auto-detected from incoming files.
- `name` string, required — The name of the stream.
- `recent_n_files_to_read_for_schema_discovery` integer — The number of resent files which will be used to discover the schema for this stream.
- `schemaless` boolean — When enabled, syncs will not validate or structure records against the stream's schema.
- `validation_policy` 'Emit Record' | 'Skip Record' | 'Wait for Discover' — The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema.
- `sourceType` 'gcs', required
- SourceGetgist
- `api_key` string, required — API key to use. Find it in the Integration Settings on your Gist dashboard at https://app.getgist.com/projects/_/settings/api-key.
- `sourceType` 'getgist', required
- SourceGetlago
- `api_key` string, required — Your API Key. See here.
- `api_url` string — Your Lago API URL
- `sourceType` 'getlago', required
- SourceGiphy
- `api_key` string, required — Your GIPHY API Key. You can create and find your API key in the GIPHY Developer Dashboard at https://developers.giphy.com/dashboard/.
- `query` string, required — A query for search endpoint
- `query_for_clips` string, required — Query for clips search endpoint
- `query_for_gif` string, required — Query for gif search endpoint
- `query_for_stickers` string, required — Query for stickers search endpoint
- `start_date` string, date-time, required
- `sourceType` 'giphy', required
- SourceGitbook
- `access_token` string, required — Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account.
- `space_id` string, required
- `sourceType` 'gitbook', required
- SourceGithub
- `api_url` string — Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub.
- `branches` string[] — List of GitHub repository branches to pull commits for, e.g. `airbytehq/airbyte/master`. If no branches are specified for a repository, the default branch will be pulled.
- `credentials` union, required — Choose how to authenticate to GitHub
- object
- `access_token` string, required — OAuth access token
- `client_id` string — OAuth Client Id
- `client_secret` string — OAuth Client secret
- `option_title` 'OAuth Credentials'
- object
- `option_title` 'PAT Credentials'
- `personal_access_token` string, required — Log into GitHub and then generate a personal access token. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","
- `max_waiting_time` integer — Max Waiting Time for rate limit. Set higher value to wait till rate limits will be resetted to continue sync
- `repositories` string[], required — List of GitHub organizations/repositories, e.g. `airbytehq/airbyte` for single repository, `airbytehq/*` for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.
- `start_date` string, date-time — The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the docs for more info
- `sourceType` 'github', required
- SourceGitlab
- `api_url` string — Please enter your basic URL from GitLab instance.
- `credentials` union, required
- object
- `access_token` string, required — Access Token for making authenticated requests.
- `auth_type` 'oauth2.0'
- `client_id` string, required — The API ID of the Gitlab developer application.
- `client_secret` string, required — The API Secret the Gitlab developer application.
- `refresh_token` string, required — The key to refresh the expired access_token.
- `token_expiry_date` string, date-time, required — The date-time when the access token should be refreshed.
- object
- `access_token` string, required — Log into your Gitlab account and then generate a personal Access Token.
- `auth_type` 'access_token'
- `groups_list` string[] — List of groups. e.g. airbyte.io.
- `projects_list` string[] — Space-delimited list of projects. e.g. airbyte.io/documentation meltano/tap-gitlab.
- `start_date` string, date-time — The date from which you'd like to replicate data for GitLab API, in the format YYYY-MM-DDT00:00:00Z. Optional. If not set, all data will be replicated. All data generated after this date will be replicated.
- `sourceType` 'gitlab', required
- SourceGlassfrog
- `api_key` string, required — API key provided by Glassfrog
- `sourceType` 'glassfrog', required
- SourceGmail
- `client_id` string, required
- `client_refresh_token` string, required
- `client_secret` string, required
- `include_spam_and_trash` boolean — Include drafts/messages from SPAM and TRASH in the results. Defaults to false.
- `sourceType` 'gmail', required
- SourceGnews
- `api_key` string, required — API Key
- `country` 'au' | 'br' | 'ca' | 'cn' | 'eg' | 'fr' | 'de' | 'gr' | 'hk' | 'in' | 'ie' | 'il' | 'it' | 'jp' | 'nl' | 'no' | 'pk' | 'pe' | 'ph' | 'pt' | 'ro' | 'ru' | 'sg' | 'es' | 'se' | 'ch' | 'tw' | 'ua' | 'gb' | 'us' — This parameter allows you to specify the country where the news articles returned by the API were published, the contents of the articles are not necessarily related to the specified country. You have to set as value the 2 letters code of the country you want to filter.
- `end_date` string — This parameter allows you to filter the articles that have a publication date smaller than or equal to the specified value. The date must respect the following format: YYYY-MM-DD hh:mm:ss (in UTC)
- `in` string[] — This parameter allows you to choose in which attributes the keywords are searched. The attributes that can be set are title, description and content. It is possible to combine several attributes.
- `language` 'ar' | 'zh' | 'nl' | 'en' | 'fr' | 'de' | 'el' | 'he' | 'hi' | 'it' | 'ja' | 'ml' | 'mr' | 'no' | 'pt' | 'ro' | 'ru' | 'es' | 'sv' | 'ta' | 'te' | 'uk'
- `nullable` string[] — This parameter allows you to specify the attributes that you allow to return null values. The attributes that can be set are title, description and content. It is possible to combine several attributes
- `query` string, required — This parameter allows you to specify your search keywords to find the news articles you are looking for. The keywords will be used to return the most relevant articles. It is possible to use logical operators with keywords. - Phrase Search Operator: This operator allows you to make an exact search. Keywords surrounded by quotation marks are used to search for articles with the exact same keyword sequence. For example the query: "Apple iPhone" will return articles matching at least once this sequence of keywords. - Logical AND Operator: This operator allows you to make sure that several keywords are all used in the article search. By default the space character acts as an AND operator, it is possible to replace the space character by AND to obtain the same result. For example the query: Apple Microsoft is equivalent to Apple AND Microsoft - Logical OR Operator: This operator allows you to retrieve articles matching the keyword a or the keyword b. It is important to note that this operator has a higher precedence than the AND operator. For example the query: Apple OR Microsoft will return all articles matching the keyword Apple as well as all articles matching the keyword Microsoft - Logical NOT Operator: This operator allows you to remove from the results the articles corresponding to the specified keywords. To use it, you need to add NOT in front of each word or phrase surrounded by quotes. For example the query: Apple NOT iPhone will return all articles matching the keyword Apple but not the keyword iPhone
- `sortby` 'publishedAt' | 'relevance' — This parameter allows you to choose with which type of sorting the articles should be returned. Two values are possible: - publishedAt = sort by publication date, the articles with the most recent publication date are returned first - relevance = sort by best match to keywords, the articles with the best match are returned first
- `start_date` string — This parameter allows you to filter the articles that have a publication date greater than or equal to the specified value. The date must respect the following format: YYYY-MM-DD hh:mm:ss (in UTC)
- `top_headlines_query` string — This parameter allows you to specify your search keywords to find the news articles you are looking for. The keywords will be used to return the most relevant articles. It is possible to use logical operators with keywords. - Phrase Search Operator: This operator allows you to make an exact search. Keywords surrounded by quotation marks are used to search for articles with the exact same keyword sequence. For example the query: "Apple iPhone" will return articles matching at least once this sequence of keywords. - Logical AND Operator: This operator allows you to make sure that several keywords are all used in the article search. By default the space character acts as an AND operator, it is possible to replace the space character by AND to obtain the same result. For example the query: Apple Microsoft is equivalent to Apple AND Microsoft - Logical OR Operator: This operator allows you to retrieve articles matching the keyword a or the keyword b. It is important to note that this operator has a higher precedence than the AND operator. For example the query: Apple OR Microsoft will return all articles matching the keyword Apple as well as all articles matching the keyword Microsoft - Logical NOT Operator: This operator allows you to remove from the results the articles corresponding to the specified keywords. To use it, you need to add NOT in front of each word or phrase surrounded by quotes. For example the query: Apple NOT iPhone will return all articles matching the keyword Apple but not the keyword iPhone
- `top_headlines_topic` 'breaking-news' | 'world' | 'nation' | 'business' | 'technology' | 'entertainment' | 'sports' | 'science' | 'health' — This parameter allows you to change the category for the request.
- `sourceType` 'gnews', required
- SourceGocardless
- `access_token` string, required — Gocardless API TOKEN
- `gocardless_environment` 'sandbox' | 'live', required — Environment you are trying to connect to.
- `gocardless_version` string, required — GoCardless version. This is a date. You can find the latest here: https://developer.gocardless.com/api-reference/#api-usage-making-requests
- `start_date` string, required — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
- `sourceType` 'gocardless', required
- SourceGoldcast
- `access_key` string, required — Your API Access Key. See here. The key is case sensitive.
- `sourceType` 'goldcast', required
- SourceGologin
- `api_key` string, required — API Key found at `https://app.gologin.com/personalArea/TokenApi`
- `start_date` string, date-time, required
- `sourceType` 'gologin', required
- SourceGong
- `access_key` string, required — Gong Access Key
- `access_key_secret` string, required — Gong Access Key Secret
- `start_date` string — The date from which to list calls, in the ISO-8601 format; if not specified, the calls start with the earliest recorded call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.
- `sourceType` 'gong', required
- SourceGoogleAds
- `conversion_window_days` integer — A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see Google's documentation.
- `credentials` object, required
- `access_token` string — The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our documentation.
- `client_id` string, required — The Client ID of your Google Ads developer application. For detailed instructions on finding this value, refer to our documentation.
- `client_secret` string, required — The Client Secret of your Google Ads developer application. For detailed instructions on finding this value, refer to our documentation.
- `developer_token` string, required — The Developer Token granted by Google to use their APIs. For detailed instructions on finding this value, refer to our documentation.
- `refresh_token` string, required — The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our documentation.
- `custom_queries_array` object[]
- `query` string, required — A custom defined GAQL query for building the report. Avoid including the segments.date field; wherever possible, Airbyte will automatically include it for incremental syncs. For more information, refer to Google's documentation.
- `table_name` string, required — The table name in your destination database for the chosen query.
- `customer_id` string — Comma-separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. For detailed instructions on finding this value, refer to our documentation.
- `customer_status_filter` string[] — A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads documentation.
- `end_date` string, date — UTC date in the format YYYY-MM-DD. Any data after this date will not be replicated. (Default value of today is used if not set)
- `start_date` string, date — UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. (Default value of two years ago is used if not set)
- `sourceType` 'google-ads', required
- SourceGoogleAnalyticsDataApi
- `convert_conversions_event` boolean — Enables conversion of `conversions:*` event metrics from integers to floats. This is beneficial for preventing data rounding when the API returns float values for any `conversions:*` fields.
- `credentials` union — Credentials for the service
- object
- `access_token` string — Access Token for making authenticated requests.
- `auth_type` 'Client'
- `client_id` string, required — The Client ID of your Google Analytics developer application.
- `client_secret` string, required — The Client Secret of your Google Analytics developer application.
- `refresh_token` string, required — The token for obtaining a new access token.
- object
- `auth_type` 'Service'
- `credentials_json` string, required — The JSON key linked to the service account used for authorization. For steps on obtaining this key, refer to the setup guide.
- `custom_reports_array` object[] — You can add your Custom Analytics report by creating one.
- `cohortSpec` union — Cohort reports creates a time series of user retention for the cohort.
- object
- …
- object
- …
- `dimensionFilter` union — Dimensions filter
- object — The FilterExpressions in andGroup have an AND relationship.
- …
- object — The FilterExpressions in orGroup have an OR relationship.
- …
- object — The FilterExpression is NOT of notExpression.
- …
- object — A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions.
- …
- `dimensions` string[], required — A list of dimensions.
- `metricFilter` union — Metrics filter
- object — The FilterExpressions in andGroup have an AND relationship.
- …
- object — The FilterExpressions in orGroup have an OR relationship.
- …
- object — The FilterExpression is NOT of notExpression.
- …
- object — A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all metrics.
- …
- `metrics` string[], required — A list of metrics.
- `name` string, required — The name of the custom report, this name would be used as stream name.
- `date_ranges_end_date` string, date — The end date from which to replicate report data in the format YYYY-MM-DD. Data generated after this date will not be included in the report. Not applied to custom Cohort reports. When no date is provided or the date is in the future, the date from today is used.
- `date_ranges_start_date` string, date — The start date from which to replicate report data in the format YYYY-MM-DD. Data generated before this date will not be included in the report. Not applied to custom Cohort reports.
- `keep_empty_rows` boolean — If false, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. More information is available in the documentation.
- `lookback_window` integer — Since attribution changes after the event date, and Google Analytics has a data processing latency, we should specify how many days in the past we should refresh the data in every run. So if you set it at 5 days, in every sync it will fetch the last bookmark date minus 5 days.
- `property_ids` string[], required — A list of your Property IDs. The Property ID is a unique number assigned to each property in Google Analytics, found in your GA4 property URL. This ID allows the connector to track the specific events associated with your property. Refer to the Google Analytics documentation to locate your property ID.
- `window_in_days` integer — The interval in days for each data request made to the Google Analytics API. A larger value speeds up data sync, but increases the chance of data sampling, which may result in inaccuracies. We recommend a value of 1 to minimize sampling, unless speed is an absolute priority over accuracy. Acceptable values range from 1 to 364. Does not apply to custom Cohort reports. More information is available in the documentation.
- `sourceType` 'google-analytics-data-api', required
- SourceGoogleCalendar
- `calendarid` string, required
- `client_id` string, required
- `client_refresh_token_2` string, required
- `client_secret` string, required
- `sourceType` 'google-calendar', required
- SourceGoogleClassroom
- `client_id` string, required
- `client_refresh_token` string, required
- `client_secret` string, required
- `sourceType` 'google-classroom', required
- SourceGoogleDirectory
- `credentials` union — Google APIs use the OAuth 2.0 protocol for authentication and authorization. The Source supports Web server application and Service accounts scenarios.
- object — For these scenario user only needs to give permission to read Google Directory data.
- `client_id` string, required — The Client ID of the developer application.
- `client_secret` string, required — The Client Secret of the developer application.
- `credentials_title` 'Web server app' — Authentication Scenario
- `refresh_token` string, required — The Token for obtaining a new access token.
- object — For these scenario user should obtain service account's credentials from the Google API Console and provide delegated email.
- `credentials_json` string, required — The contents of the JSON service account key. See the docs for more information on how to generate this key.
- `credentials_title` 'Service accounts' — Authentication Scenario
- `email` string, required — The email of the user, which has permissions to access the Google Workspace Admin APIs.
- `sourceType` 'google-directory', required
- SourceGoogleDrive — Used during spec; allows the developer to configure the cloud provider specific options that are needed when users configure a file-based source.
- `credentials` union, required — Credentials for connecting to the Google Drive API
- object
- `auth_type` 'Client', required
- `client_id` string, required — Client ID for the Google Drive API
- `client_secret` string, required — Client Secret for the Google Drive API
- `refresh_token` string, required — Refresh Token for the Google Drive API
- object
- `auth_type` 'Service', required
- `service_account_info` string, required — The JSON key of the service account to use for authorization. Read more here.
- `delivery_method` union
- object — Recommended - Extract and load structured records into your destination of choice. This is the classic method of moving data in Airbyte. It allows for blocking and hashing individual fields or files from a structured schema. Data can be flattened, typed and deduped depending on the destination.
- `delivery_type` 'use_records_transfer', required
- object — Copy raw files without parsing their contents. Bits are copied into the destination exactly as they appeared in the source. Recommended for use with unstructured text data, non-text and compressed files.
- `delivery_type` 'use_file_transfer', required
- `preserve_directory_structure` boolean — If enabled, sends subdirectory folder structure along with source file names to the destination. Otherwise, files will be synced by their names only. This option is ignored when file-based replication is not enabled.
- object — Sends one identity stream and one for more permissions (ACL) streams to the destination. This data can be used in downstream systems to recreate permission restrictions mirroring the original source.
- `delivery_type` 'use_permissions_transfer', required
- `domain` string — The Google domain of the identities.
- `include_identities_stream` boolean — This data can be used in downstream systems to recreate permission restrictions mirroring the original source
- `folder_url` string, required — URL for the folder you want to sync. Using individual streams and glob patterns, it's possible to only sync a subset of all files located in the folder.
- `start_date` string, date-time — UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated.
- `streams` object[], required — Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table.
- `days_to_sync_if_history_is_full` integer — When the state history of the file store is full, syncs will only read files that were last modified in the provided day range.
- `format` union, required — The configuration options that are used to alter how to read incoming files that deviate from the standard formatting.
- object
- …
- object
- …
- object
- …
- object
- …
- object — Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one record per file.
- …
- object
- …
- `globs` string[] — The pattern used to specify which files should be selected from the file system. For more information on glob pattern matching look here.
- `input_schema` string — The schema that will be used to validate records extracted from the file. This will override the stream schema that is auto-detected from incoming files.
- `name` string, required — The name of the stream.
- `recent_n_files_to_read_for_schema_discovery` integer — The number of resent files which will be used to discover the schema for this stream.
- `schemaless` boolean — When enabled, syncs will not validate or structure records against the stream's schema.
- `validation_policy` 'Emit Record' | 'Skip Record' | 'Wait for Discover' — The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema.
- `sourceType` 'google-drive', required
- SourceGoogleForms
- `client_id` string, required
- `client_refresh_token` string, required
- `client_secret` string, required
- `form_id` unknown[], required
- unknown
- `sourceType` 'google-forms', required
- SourceGooglePagespeedInsights
- `api_key` string — Google PageSpeed API Key. See here. The key is optional - however the API is heavily rate limited when using without API Key. Creating and using the API key therefore is recommended. The key is case sensitive.
- `categories` string[], required — Defines which Lighthouse category to run. One or many of: "accessibility", "best-practices", "performance", "pwa", "seo".
- `strategies` string[], required — The analyses strategy to use. Either "desktop" or "mobile".
- `urls` string[], required — The URLs to retrieve pagespeed information from. The connector will attempt to sync PageSpeed reports for all the defined URLs. Format: https://(www.)url.domain
- `sourceType` 'google-pagespeed-insights', required
- SourceGoogleSearchConsole
- `always_use_aggregation_type_auto` boolean — Some search analytics streams fail with a 400 error if the specified `aggregationType` is not supported. This is customer implementation dependent and if this error is encountered, enable this setting which will override the existing `aggregationType` to use `auto` which should resolve the stream errors.
- `authorization` union, required
- object
- `access_token` string — Access token for making authenticated requests. Read more here.
- `auth_type` 'Client', required
- `client_id` string, required — The client ID of your Google Search Console developer application. Read more here.
- `client_secret` string, required — The client secret of your Google Search Console developer application. Read more here.
- `refresh_token` string, required — The token for obtaining a new access token. Read more here.
- object
- `auth_type` 'Service', required
- `email` string, required — The email of the user which has permissions to access the Google Workspace Admin APIs.
- `service_account_info` string, required — The JSON key of the service account to use for authorization. Read more here.
- `custom_reports_array` object[] — You can add your Custom Analytics report by creating one.
- `dimensions` string[], required — A list of available dimensions. Please note, that for technical reasons `date` is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with `site_url` and `search_type`.
- `name` string, required — The name of the custom report, this name would be used as stream name
- `data_state` 'final' | 'all' — If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our full documentation.
- `end_date` string, date — UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward.
- `num_workers` integer — The number of worker threads to use for the sync. For more details on Google Search Console rate limits, refer to the docs.
- `site_urls` string[], required — The URLs of the website property attached to your GSC account. Learn more about properties here.
- `start_date` string, date — UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated.
- `sourceType` 'google-search-console', required
- SourceGoogleSheets
- `allow_leading_numbers` boolean — Allows column names to start with numbers. Example: "50th Percentile" → "50_th_percentile" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled.
- `batch_size` integer — Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on Google Sheets API limits documentation, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value.
- `combine_letter_number_pairs` boolean — Combines adjacent letters and numbers. Example: "Q3 2023" → "q3_2023" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled.
- `combine_number_word_pairs` boolean — Combines adjacent numbers and words. Example: "50th Percentile?" → "_50th_percentile_" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled.
- `credentials` union, required — Credentials for connecting to the Google Sheets API
- object
- `auth_type` 'Client', required
- `client_id` string, required — Enter your Google application's Client ID. See Google's documentation for more information.
- `client_secret` string, required — Enter your Google application's Client Secret. See Google's documentation for more information.
- `refresh_token` string, required — Enter your Google application's refresh token. See Google's documentation for more information.
- object
- `auth_type` 'Service', required
- `service_account_info` string, required — The JSON key of the service account to use for authorization. Read more here.
- `names_conversion` boolean — Converts column names to a SQL-compliant format (snake_case, lowercase, etc). If enabled, you can further customize the sanitization using the options below.
- `remove_leading_trailing_underscores` boolean — Removes leading and trailing underscores from column names. Does not remove leading underscores from column names that start with a number. Example: "50th Percentile? "→ "_50_th_percentile" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled.
- `remove_special_characters` boolean — Removes all special characters from column names. Example: "Example ID*" → "example_id" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled.
- `spreadsheet_id` string, required — Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.
- `stream_name_overrides` object[] — **Overridden streams will default to Sync Mode: Full Refresh (Append), which does not support primary keys. If you want to use primary keys and deduplication, update the sync mode to "Full Refresh | Overwrite + Deduped" in your connection settings.** Allows you to rename streams (Google Sheet tab names) as they appear in Airbyte. Each item should be an object with a `source_stream_name` (the exact name of the sheet/tab in your spreadsheet) and a `custom_stream_name` (the name you want it to appear as in Airbyte and the destination). If a `source_stream_name` is not found in your spreadsheet, it will be ignored and the default name will be used. This feature only affects stream (sheet/tab) names, not field/column names. If you want to rename fields or column names, you can do so using the Airbyte Mappings feature after your connection is created. See the Airbyte documentation for more details on how to use Mappings. Examples: - To rename a sheet called "Sheet1" to "sales_data", and "2024 Q1" to "q1_2024": [ { "source_stream_name": "Sheet1", "custom_stream_name": "sales_data" }, { "source_stream_name": "2024 Q1", "custom_stream_name": "q1_2024" } ] - If you do not wish to rename any streams, leave this blank.
- `custom_stream_name` string, required — The name you want this stream to appear as in Airbyte and your destination.
- `source_stream_name` string, required — The exact name of the sheet/tab in your Google Spreadsheet.
- `sourceType` 'google-sheets', required
- SourceGoogleTasks
- `api_key` string, required
- `records_limit` string — The maximum number of records to be returned per request
- `start_date` string, date-time, required
- `sourceType` 'google-tasks', required
- SourceGoogleWebfonts
- `alt` string — Optional, Available params- json, media, proto
- `api_key` string, required — API key is required to access google apis, For getting your's goto google console and generate api key for Webfonts
- `prettyPrint` string — Optional, boolean type
- `sort` string — Optional, to find how to sort
- `sourceType` 'google-webfonts', required
- SourceGorgias
- `domain_name` string, required — Domain name given for gorgias, found as your url prefix for accessing your website
- `password` string
- `start_date` string, date-time, required
- `username` string, required
- `sourceType` 'gorgias', required
- SourceGreenhouse
- `api_key` string, required — Greenhouse API Key. See the docs for more information on how to generate this key.
- `sourceType` 'greenhouse', required
- SourceGreythr
- `base_url` string, required — https://api.greythr.com
- `domain` string, required — Your GreytHR Host URL
- `password` string
- `username` string, required
- `sourceType` 'greythr', required
- SourceGridly
- `api_key` string, required
- `grid_id` string, required — ID of a grid, or can be ID of a branch
- `sourceType` 'gridly', required
- SourceGuru
- `password` string
- `search_cards_query` string — Query for searching cards
- `start_date` string, date-time, required
- `team_id` string — Team ID received through response of /teams streams, make sure about access to the team
- `username` string, required
- `sourceType` 'guru', required
- SourceGutendex
- `author_year_end` string — (Optional) Defines the maximum birth year of the authors. Books by authors born after the end year will not be returned. Supports both positive (CE) or negative (BCE) integer values
- `author_year_start` string — (Optional) Defines the minimum birth year of the authors. Books by authors born prior to the start year will not be returned. Supports both positive (CE) or negative (BCE) integer values
- `copyright` string — (Optional) Use this to find books with a certain copyright status - true for books with existing copyrights, false for books in the public domain in the USA, or null for books with no available copyright information.
- `languages` string — (Optional) Use this to find books in any of a list of languages. They must be comma-separated, two-character language codes.
- `search` string — (Optional) Use this to search author names and book titles with given words. They must be separated by a space (i.e. %20 in URL-encoded format) and are case-insensitive.
- `sort` string — (Optional) Use this to sort books - ascending for Project Gutenberg ID numbers from lowest to highest, descending for IDs highest to lowest, or popular (the default) for most popular to least popular by number of downloads.
- `topic` string — (Optional) Use this to search for a case-insensitive key-phrase in books' bookshelves or subjects.
- `sourceType` 'gutendex', required
- SourceHardcodedRecords
- `count` integer — How many records per stream should be generated
- `sourceType` 'hardcoded-records', required
- SourceHarness
- `account_id` string, required — Harness Account ID
- `api_key` string, required
- `api_url` string — The API URL for fetching data from Harness
- `sourceType` 'harness', required
- SourceHarvest
- `account_id` string, required — Harvest account ID. Required for all Harvest requests in pair with Personal Access Token
- `credentials` union — Choose how to authenticate to Harvest.
- object
- `auth_type` 'Client'
- `client_id` string, required — The Client ID of your Harvest developer application.
- `client_secret` string, required — The Client Secret of your Harvest developer application.
- `refresh_token` string, required — Refresh Token to renew the expired Access Token.
- object
- `api_token` string, required — Log into Harvest and then create new personal access token.
- `auth_type` 'Token'
- `replication_start_date` string, date-time, required — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
- `sourceType` 'harvest', required
- SourceHeight
- `api_key` string, required
- `search_query` string — Search query to be used with search stream
- `start_date` string, date-time, required
- `sourceType` 'height', required
- SourceHellobaton
- `api_key` string, required — authentication key required to access the api endpoints
- `company` string, required — Company name that generates your base api url
- `sourceType` 'hellobaton', required
- SourceHelpScout
- `client_id` string, required
- `client_secret` string, required
- `start_date` string, date-time, required
- `sourceType` 'help-scout', required
- SourceHibob
- `is_sandbox` boolean, required — Toggle true if this instance is a HiBob sandbox
- `password` string
- `username` string, required
- `sourceType` 'hibob', required
- SourceHighLevel
- `api_key` string, required
- `location_id` string, required
- `start_date` string, date-time, required
- `sourceType` 'high-level', required
- SourceHoorayhr
- `hoorayhrpassword` string, required
- `hoorayhrusername` string, required
- `sourceType` 'hoorayhr', required
- SourceHubplanner
- `api_key` string, required — Hubplanner API key. See https://github.com/hubplanner/API#authentication for more details.
- `sourceType` 'hubplanner', required
- SourceHubspot
- `credentials` union, required — Choose how to authenticate to HubSpot.
- object
- `client_id` string, required — The Client ID of your HubSpot developer application. See the Hubspot docs if you need help finding this ID.
- `client_secret` string, required — The client secret for your HubSpot developer application. See the Hubspot docs if you need help finding this secret.
- `credentials_title` 'OAuth Credentials', required — Name of the credentials
- `refresh_token` string, required — Refresh token to renew an expired access token. See the Hubspot docs if you need help finding this token.
- object
- `access_token` string, required — HubSpot Access token. See the Hubspot docs if you need help finding this token.
- `credentials_title` 'Private App Credentials', required — Name of the credentials set
- `enable_experimental_streams` boolean — If enabled then experimental streams become available for sync.
- `num_worker` integer — The number of worker threads to use for the sync.
- `start_date` string, date-time — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization.
- `sourceType` 'hubspot', required
- SourceHuggingFaceDatasets
- `dataset_name` string, required
- `dataset_splits` unknown[] — Splits to import. Will import all of them if nothing is provided (see https://huggingface.co/docs/dataset-viewer/en/configs_and_splits for more details)
- unknown
- `dataset_subsets` unknown[] — Dataset Subsets to import. Will import all of them if nothing is provided (see https://huggingface.co/docs/dataset-viewer/en/configs_and_splits for more details)
- unknown
- `sourceType` 'hugging-face-datasets', required
- SourceHumanitix
- `api_key` string, required
- `sourceType` 'humanitix', required
- SourceHuntr
- `api_key` string, required
- `sourceType` 'huntr', required
- SourceIlluminaBasespace
- `access_token` string, required — BaseSpace access token. Instructions for obtaining your access token can be found in the BaseSpace Developer Documentation.
- `domain` string, required — Domain name of the BaseSpace instance (e.g., euw2.sh.basespace.illumina.com)
- `user` string, required — Providing a user ID restricts the returned data to what that user can access. If you use the default ('current'), all data accessible to the user associated with the API key will be shown.
- `sourceType` 'illumina-basespace', required
- SourceImagga
- `api_key` string, required — Your Imagga API key, available in your Imagga dashboard. Could be found at `https://imagga.com/profile/dashboard`
- `api_secret` string, required — Your Imagga API secret, available in your Imagga dashboard. Could be found at `https://imagga.com/profile/dashboard`
- `img_for_detection` string — An image for detection endpoints
- `sourceType` 'imagga', required
- SourceIncidentIo
- `api_key` string, required — API key to use. Find it at https://app.incident.io/settings/api-keys
- `sourceType` 'incident-io', required
- SourceInflowinventory
- `api_key` string, required
- `companyid` string, required
- `sourceType` 'inflowinventory', required
- SourceInsightful
- `api_token` string, required — Your API token for accessing the Insightful API. Generate it by logging in as an Admin to your organization's account, navigating to the API page, and creating a new token. Note that this token will only be shown once, so store it securely.
- `start_date` string, date-time, required
- `sourceType` 'insightful', required
- SourceInsightly
- `start_date` string, date-time, nullable, required — The date from which you'd like to replicate data for Insightly in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. Note that it will be used only for incremental streams.
- `token` string, nullable, required — Your Insightly API token.
- `sourceType` 'insightly', required
- SourceInstagram
- `access_token` string, required — The value of the access token generated with instagram_basic, instagram_manage_insights, pages_show_list, pages_read_engagement, Instagram Public Content Access permissions. See the docs for more information
- `client_id` string — The Client ID for your Oauth application
- `client_secret` string — The Client Secret for your Oauth application
- `num_workers` integer — The number of worker threads to use for the sync.
- `start_date` string, date-time — The date from which you'd like to replicate data for User Insights, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.
- `sourceType` 'instagram', required
- SourceInstatus
- `api_key` string, required — Instatus REST API key
- `sourceType` 'instatus', required
- SourceIntercom
- `access_token` string, required — Access token for making authenticated requests. See the Intercom docs for more information.
- `activity_logs_time_step` integer — Set lower value in case of failing long running sync of Activity Logs stream.
- `client_id` string — Client Id for your Intercom application.
- `client_secret` string — Client Secret for your Intercom application.
- `lookback_window` integer — The number of days to shift the state value backward for record sync
- `start_date` string, date-time, required — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
- `sourceType` 'intercom', required
- SourceIntruder
- `access_token` string, required — Your API Access token. See here.
- `sourceType` 'intruder', required
- SourceInvoiced
- `api_key` string, required — API key to use. Find it at https://invoiced.com/account
- `sourceType` 'invoiced', required
- SourceInvoiceninja
- `api_key` string, required
- `sourceType` 'invoiceninja', required
- SourceIp2whois
- `api_key` string — Your API Key. See here.
- `domain` string — Domain name. See here.
- `sourceType` 'ip2whois', required
- SourceIterable
- `api_key` string, required — Iterable API Key. See the docs for more information on how to obtain this key.
- `start_date` string, date-time, required — The date from which you'd like to replicate data for Iterable, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
- `sourceType` 'iterable', required
- SourceJamfPro
- `password` string
- `subdomain` string, required — The unique subdomain for your Jamf Pro instance.
- `username` string, required
- `sourceType` 'jamf-pro', required
- SourceJira
- `api_token` string, required — Jira API Token. See the docs for more information on how to generate this key. API Token is used for Authorization to your account by BasicAuth.
- `domain` string, required — The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com
- `email` string, required — The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
- `lookback_window_minutes` integer — When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced.
- `num_workers` integer — The number of worker threads to use for the sync.
- `projects` string[] — List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.
- `start_date` string, date-time — The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the documentation.
- `sourceType` 'jira', required
- SourceJobnimbus
- `api_key` string, required — API key to use. Find it by logging into your JobNimbus account, navigating to settings, and creating a new API key under the API section.
- `sourceType` 'jobnimbus', required
- SourceJotform
- `api_endpoint` union, required
- object
- `api_endpoint` 'basic'
- `url_prefix` 'Standard' | 'EU' | 'HIPAA', required — You can access our API through the following URLs - Standard API Usage (Use the default API URL - https://api.jotform.com), For EU (Use the EU API URL - https://eu-api.jotform.com), For HIPAA (Use the HIPAA API URL - https://hipaa-api.jotform.com)
- object
- `api_endpoint` 'enterprise'
- `enterprise_url` string, required — Upgrade to Enterprise to make your API url your-domain.com/API or subdomain.jotform.com/API instead of api.jotform.com
- `api_key` string, required
- `end_date` string, date-time, required
- `start_date` string, date-time, required
- `sourceType` 'jotform', required
- SourceJudgeMeReviews
- `api_key` string, required
- `shop_domain` string, required — example.myshopify.com
- `start_date` string, date-time, required
- `sourceType` 'judge-me-reviews', required
- SourceJustSift
- `api_token` string, required — API token to use for accessing the Sift API. Obtain this token from your Sift account administrator.
- `sourceType` 'just-sift', required
- SourceJustcall
- `api_key_2` string, required
- `start_date` string, date-time, required
- `sourceType` 'justcall', required
- SourceK6Cloud
- `api_token` string, required — Your API Token. See here. The key is case sensitive.
- `sourceType` 'k6-cloud', required
- SourceKatana
- `api_key` string, required — API key to use. Find it at https://katanamrp.com/login/
- `start_date` string, date-time, required
- `sourceType` 'katana', required
- SourceKeka
- `api_key` string, required
- `client_id` string, required — Your client identifier for authentication.
- `client_secret` string, required — Your client secret for secure authentication.
- `grant_type` string, required
- `scope` string, required
- `sourceType` 'keka', required
- SourceKisi
- `api_key` string, required — Your KISI API Key
- `sourceType` 'kisi', required
- SourceKissmetrics
- `password` string
- `username` string, required
- `sourceType` 'kissmetrics', required
- SourceKlarna
- `password` string, required — A string which is associated with your Merchant ID and is used to authorize use of Klarna's APIs (https://developers.klarna.com/api/#authentication)
- `playground` boolean, required — Propertie defining if connector is used against playground or production environment
- `region` 'eu' | 'na' | 'oc', required — Base url region (For playground eu https://docs.klarna.com/klarna-payments/api/payments-api/#tag/API-URLs). Supported 'eu', 'na', 'oc'
- `username` string, required — Consists of your Merchant ID (eid) - a unique number that identifies your e-store, combined with a random string (https://developers.klarna.com/api/#authentication)
- `sourceType` 'klarna', required
- SourceKlausApi
- `account` integer, required — getting data by account
- `api_key` string, required — API access key used to retrieve data from the KLAUS API.
- `start_date` string, date-time — Start getting data from that date.
- `workspace` integer, required — getting data by workspace
- `sourceType` 'klaus-api', required
- SourceKlaviyo
- `api_key` string, required — Klaviyo API Key. See our docs if you need help finding this key.
- `disable_fetching_predictive_analytics` boolean — Certain streams like the profiles stream can retrieve predictive analytics data from Klaviyo's API. However, at high volume, this can lead to service availability issues on the API which can be improved by not fetching this field. WARNING: Enabling this setting will stop the "predictive_analytics" column from being populated in your downstream destination.
- `num_workers` integer — The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Klaviyo plan. More info about the rate limit plan tiers can be found on Klaviyo's API docs.
- `start_date` string, date-time — UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated.
- `sourceType` 'klaviyo', required
- SourceKyve
- `pool_ids` string, required — The IDs of the KYVE storage pool you want to archive. (Comma separated)
- `start_ids` string, required — The start-id defines, from which bundle id the pipeline should start to extract the data. (Comma separated)
- `url_base` string, required — URL to the KYVE Chain API.
- `sourceType` 'kyve', required
- SourceLaunchdarkly
- `access_token` string, required — Your Access token. See here.
- … truncated; see the full OpenAPI document linked below
## Other responses
- `403` — Not allowed
- `404` — Not found
---
[API](https://skmtc.net/airbytehq/apis/airbyte-api.md) · [All operations](https://skmtc.net/airbytehq/apis/airbyte-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/airbytehq/airbyte-api/revisions/55ddc054e5b5/schema)