For the complete documentation index, see llms.txt. This page is also available as Markdown.

OpenAI Ads

Connect your OpenAI Ads to your data warehouse. Sync campaigns, ads, insights, conversions, and feeds to BigQuery, Redshift, Postgres, Databricks, and more.

Using the Erathos platform

When selecting OpenAI Ads as a new connector on the Erathos platform, you will need to name your connection and fill in the following form:

  • Token — your OpenAI Ads API key, a bearer token scoped to a single ad account, used to authenticate all requests to the OpenAI Ads API

With this connection created you can seamlessly move your OpenAI Ads data to your BigQuery, Redshift or Postgres data warehouse.

How to find my token?

OpenAI Ads authenticates with a bearer API key issued from Ads Manager. Sign in to the ad account you want to sync, go to Settings → Integrations → API Keys, and create a new API key. Note that each key is scoped to a single ad account — generate it from the account whose data you want to bring into Erathos.

Copy the generated key and keep it secure. The authentication scheme is documented in the OpenAI Ads API reference, where you can also verify your key's scopes and permissions.

Paste the key into the Token field on the Erathos platform and click Save and close to complete the setup.

Endpoints and fields

ad_account

Sync type availability: Full-refresh

Parent of lead_sync_subscriptions

Field
Type

id

text

name

text

status

text

currency

text

country

text

timezone_name

text

business_id

text

created_at

timestamp

updated_at

timestamp

ad_account_insights

Sync type availability: Full and incremental refresh

Cursor: updated_at

Field
Type
Cursor

impressions

integer

clicks

integer

spend

float

conversions

integer

currency

text

updated_at

date

✓

ad_accounts

Sync type availability: Full-refresh

Field
Type

id

text

name

text

status

text

currency

text

country

text

timezone_name

text

created_at

timestamp

updated_at

timestamp

ad_group_insights

Sync type availability: Full and incremental refresh

Cursor: updated_at

Child of ad_groups

Field
Type
Cursor

ad_group_id

text

impressions

integer

clicks

integer

spend

float

conversions

integer

currency

text

updated_at

date

✓

ad_groups

Sync type availability: Full-refresh

Parent of ad_group_insights

Field
Type

id

text

name

text

campaign_id

text

status

text

daily_budget

float

bid_strategy

text

start_time

timestamp

end_time

timestamp

created_at

timestamp

updated_at

timestamp

ad_insights

Sync type availability: Full and incremental refresh

Cursor: updated_at

Child of ads

Field
Type
Cursor

ad_id

text

impressions

integer

clicks

integer

spend

float

conversions

integer

currency

text

updated_at

date

✓

ads

Sync type availability: Full-refresh

Parent of ad_insights

Field
Type

id

text

name

text

ad_group_id

text

status

text

format

text

created_at

timestamp

updated_at

timestamp

bulk_mutation_job

Sync type availability: Full-refresh

Parent of bulk_mutation_job_operations

Field
Type

id

text

status

text

operation_count

integer

created_at

timestamp

completed_at

timestamp

updated_at

timestamp

bulk_mutation_job_operations

Sync type availability: Full-refresh

Child of bulk_mutation_job

Field
Type

id

text

type

text

status

text

entity_id

text

error_message

text

created_at

timestamp

campaign_insights

Sync type availability: Full and incremental refresh

Cursor: updated_at

Child of campaigns

Field
Type
Cursor

campaign_id

text

impressions

integer

clicks

integer

spend

float

conversions

integer

currency

text

updated_at

date

✓

campaigns

Sync type availability: Full-refresh

Parent of campaign_insights

Field
Type

id

text

name

text

objective

text

status

text

daily_budget

float

lifetime_budget

float

start_time

timestamp

end_time

timestamp

created_at

timestamp

updated_at

timestamp

conversions_event_settings

Sync type availability: Full-refresh

Field
Type

id

text

event_name

text

status

text

default_value

float

currency

text

created_at

timestamp

updated_at

timestamp

conversions_events

Sync type availability: Full-refresh

Child of conversions_pixels

Field
Type

id

text

event_name

text

event_time

timestamp

event_source_url

text

value

float

currency

text

conversions_insights

Sync type availability: Full and incremental refresh

Cursor: updated_at

Field
Type
Cursor

event_name

text

conversions

integer

conversion_value

float

currency

text

updated_at

date

✓

conversions_pixels

Sync type availability: Full-refresh

Parent of conversions_events

Field
Type

id

text

name

text

status

text

created_at

timestamp

updated_at

timestamp

custom_audience_operations

Sync type availability: Full-refresh

Child of custom_audiences

Field
Type

id

text

type

text

status

text

payload_count

integer

created_at

timestamp

updated_at

timestamp

custom_audiences

Sync type availability: Full-refresh

Parent of custom_audience_operations

Field
Type

id

text

name

text

type

text

description

text

approximate_size

integer

status

text

created_at

timestamp

updated_at

timestamp

feed_products_query

Sync type availability: Full-refresh

Child of feeds

Field
Type

id

text

title

text

price

float

currency

text

availability

text

brand

text

updated_at

timestamp

feed_sftp_access

Sync type availability: Full-refresh

Child of feeds

Field
Type

username

text

host

text

port

integer

directory

text

expires_at

timestamp

feed_uploads

Sync type availability: Full-refresh

Field
Type

id

text

feed_id

text

status

text

started_at

timestamp

completed_at

timestamp

item_count

integer

created_at

timestamp

updated_at

timestamp

feeds

Sync type availability: Full-refresh

Parent of feed_products_query, feed_sftp_access

Field
Type

id

text

name

text

type

text

status

text

item_count

integer

created_at

timestamp

updated_at

timestamp

Sync type availability: Full-refresh

Field
Type

name

text

code

text

type

text

country_code

text

parent_code

text

lead_sync_subscriptions

Sync type availability: Full-refresh

Child of ad_account

Field
Type

id

text

callback_url

text

event_type

text

status

text

created_at

timestamp

updated_at

timestamp

partner_data_upload

Sync type availability: Full-refresh

Field
Type

id

text

status

text

file_name

text

record_count

integer

created_at

timestamp

updated_at

timestamp

spend_limit_windows

Sync type availability: Full-refresh

Field
Type

spend_limit

float

currency

text

start_time

timestamp

end_time

timestamp

status

text

Entity Relationships

Last updated