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",
  "config": {
    "sync_mode": "AllAccounts | SpecificAccounts",
    "timeframe_months": "THREE | SIX | TWELVE | TWENTY_FOUR | ALL_TIME",
    "sync_multiple_accounts": true,
    "accounts": [
      {
        "name": "other_linked_account_name"
      }
    ],
    "business_accounts": [
      "string"
    ],
    "custom_reports": [
      {
        "custom_events_included": true,
        "conversions_report_included": true,
        "event_names": [
          "string"
        ],
        "time_zone_mode": "ACCOUNT | USER",
        "level": "ACCOUNT | CAMPAIGN | AD_GROUP | AD | POST | NONE",
        "report_fields": [
          "string"
        ],
        "segmentation": "COUNTRY | METRO | INTEREST | COMMUNITY | PLACEMENT | NONE",
        "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`.
`sync_multiple_accounts`	When this parameter is set to `true`, we sync the data of the additional linked accounts. When this parameter is set to `false`, we sync only the data from the main account that was used for authorization
`accounts`	Accounts
`accounts[0].name`	Reddit username of the additional linked account.
`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`	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_access and refresh_token parameters in the auth section.

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_token`	The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
`client_access`	Your application client access fields
`client_access.client_secret`	`Client Secret` of your Reddit Ads client application.
`client_access.client_id`	`Client ID` of your Reddit Ads client application.

By using the Connect Card or the Fivetran dashboard.