OpenAI Ads API Configuration Private Preview

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": "openai_ads_reports",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "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",
  "data_checks": true,
  "config": {
    "api_key": "your_api_key",
    "reports": [
      {
        "aggregation_level": "AD_ACCOUNT | AD | AD_GROUP | CAMPAIGN",
        "fields": [
          "string"
        ],
        "segments": "[\"COUNTRY\"]",
        "table": "ad_report_by_country",
        "time_granularity": "DAILY | MONTHLY | HOURLY"
      }
    ],
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`api_key`	Retrieve from your OpenAI Ads dashboard (Settings > API keys). Keys are scoped to a single ad account.
`reports`	Custom reports. Each report lands in its own destination table, in addition to the prebuilt report and metadata tables that are always synced.
`reports[0].aggregation_level`	The entity level the report's rows are aggregated at: AD_ACCOUNT, CAMPAIGN, AD_GROUP, or AD.
`reports[0].fields`	Report fields and metrics to sync. Available fields depend on the selected aggregation level and segment.
`reports[0].segments`	Use one segment at most to break the report out by: PRODUCT, COUNTRY, or DEVICE. Not allowed in combination with the hourly time granularity.
`reports[0].table`	Destination table name for the report. Must be unique and can't be changed once the report is added.
`reports[0].time_granularity`	The time granularity for the report's rows: NONE, HOURLY, DAILY, or MONTHLY.
`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 value for the api_key parameter in the request.

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

{
  "service": "openai_ads_reports",
  "group_id": "group_id",
  "config": {
    "api_key": "your_api_key"
  }
}

By using the Connect Card or the Fivetran dashboard.