Apple App Store API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

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

{
  "group_id": "group_id",
  "service": "itunes_connect",
  "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,
    "all_fields": 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": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "app_sync_mode": "AllApps | SpecificApps",
    "apps": [
      0
    ],
    "issuer_id": "your_issuer_id",
    "key_id": "your_key_id",
    "key_type": "Team",
    "private_key": "your_private_key",
    "timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
    "vendors_id": [
      "string"
    ],
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`app_sync_mode`	Whether to sync all apps or specific apps.
`apps`	Specific apps to sync. Must be populated if `app_sync_mode` is set to `SpecificApps`.
`issuer_id`	Your Issuer ID. Must be populated if `key_type` is set to `Team`
`key_id`	Your Key ID
`key_type`	Key Type
`private_key`	Your Private Key
`timeframe_months`	Historical sync time frame in months.
`vendors_id`	Your vendors id
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.