LinkedIn Ad Analytics API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "linkedin_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": "AllAccounts | SpecificAccounts",
    "reports": [
      "string"
    ],
    "post_click_attribution_window_size": "DAY_1 | DAY_30 | DAY_7 | DAY_28",
    "ad_analytics": "SpecificReports | AllReports",
    "timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
    "view_through_attribution_window_size": "DAY_1 | DAY_30 | DAY_7 | DAY_28",
    "accounts": [
      "string"
    ],
    "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. Default value: `AllAccounts`
`reports`	Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
`post_click_attribution_window_size`	The time period to attribute conversions based on clicks. Default value: `DAY_30`
`ad_analytics`	Whether to sync all analytic reports or specific. Default value: `AllReports`
`timeframe_months`	Number of months for which to query reporting data included in the initial sync. This number cannot be modified once the connector is created. Default value: `ALL_TIME`.
`view_through_attribution_window_size`	The time period to attribute conversions based on views. Default value: `DAY_7`
`accounts`	Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
`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": "linkedin_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`
`client_access.client_secret`	`Client Secret` of your LinkedIn client application.
`client_access.client_id`	`Client ID` of your LinkedIn client application.

By using the Connect Card or the Fivetran dashboard.