Reddit Ads API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "reddit_ads",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"destination_configuration": {
"virtual_warehouse": "virtual_warehouse"
},
"config": {
"sync_mode": "AllAccounts | SpecificAccounts",
"timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
"business_accounts": [
"string"
],
"custom_reports": [
{
"custom_events_included": true,
"conversions_report_included": true,
"event_names": [
"string"
],
"time_zone_mode": "USER",
"level": "ACCOUNT | AD | POST | AD_GROUP | NONE | CAMPAIGN",
"report_fields": [
"string"
],
"segmentation": "PLACEMENT | COUNTRY | METRO | COMMUNITY | NONE | INTEREST",
"time_zone": "GMT",
"report_name": "test_report_name"
}
],
"schema": "schema_name"
},
"auth": {
"refresh_token": "my_refresh_token",
"client_access": {
"client_secret": "my_client_secret",
"client_id": "my_client_id"
}
}
}Config parameters
| Name | Description |
|---|---|
sync_mode | Whether to sync all accounts or specific accounts. |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: TWELVE. |
business_accounts | Specific Accounts to sync. Must be populated if sync_mode is set to SpecificAccounts. |
custom_reports | The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data. |
custom_reports[0].custom_events_included | The boolean value specifying whether the custom events are included in event conversions report. Default value: false |
custom_reports[0].conversions_report_included | The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: false |
custom_reports[0].event_names | The list of events the conversion data will be synchronised for |
custom_reports[0].time_zone_mode | When this parameter is set to ACCOUNT, connector will use account related time zone to sync report data. Default value: ACCOUNT. Possible values: ACCOUNT, USER |
custom_reports[0].level | Level of custom report. |
custom_reports[0].report_fields | The list of fields included in custom report |
custom_reports[0].segmentation | Level of custom report. |
custom_reports[0].time_zone | The specific time zone to sync report data if useAccountTimeZone set to false. |
custom_reports[0].report_name | The table name within the schema to which connector syncs the data of the specific report. |
schema (required) | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "reddit_ads", "group_id": "group_id", "auth": { "client_access": { "client_secret": "my_client_secret", "client_id": "my_client_id" }, "refresh_token": "my_refresh_token" } }Auth Parameters
Name Description refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.client_accessYour application client access fields client_access.client_secretClient Secretof your Reddit Ads client application.client_access.client_idClient IDof your Reddit Ads client application. By using the Connect Card or the Fivetran dashboard.