Pinterest Ads API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "pinterest_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"
  },
  "destination_schema_names": "SOURCE_NAMING",
  "config": {
    "sync_mode": "SpecificAdvertisers | AllAdvertisers",
    "view_attribution_window": "ZERO | THIRTY | SIXTY | FOURTEEN | ONE | SEVEN",
    "refresh_token_expires_at": "1717858800",
    "report_granularity": "HOUR | DAY",
    "timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
    "advertisers": [
      "string"
    ],
    "conversion_report_time": "CONVERSION_EVENT | AD_EVENT",
    "engagement_attribution_window": "ZERO | THIRTY | SIXTY | FOURTEEN | ONE | SEVEN",
    "click_attribution_window": "ZERO | THIRTY | SIXTY | FOURTEEN | ONE | SEVEN",
    "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 advertisers or specific advertisers.
`view_attribution_window`	The number of days to use as the conversion attribution window for a 'view' action.
`refresh_token_expires_at`	The expiration date of the refresh token. Unix timestamp in seconds
`report_granularity`	Granularity at which reports will be
`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: `THREE`.
`advertisers`	Specific Advertisers to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisers`.
`conversion_report_time`	The date that the user interacted with the ad OR completed a conversion event.
`engagement_attribution_window`	The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
`click_attribution_window`	The number of days to use as the conversion attribution window for a 'click' action.
`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_access and refresh_token parameters in the auth section.

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

{
  "service": "pinterest_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 Pinterest client application.
`client_access.client_id`	`Client ID` of your Pinterest client application.

By using the Connect Card or the Fivetran dashboard.