Overview

The V4MOS.AI OpenAI Ads API gives you the raw records synced from the OpenAI Ads accounts connected to your organization: ad accounts, campaigns, ad groups, ads and their daily insights. Rows come as they were synced, with the warehouse column names (snake_case), so you can load them straight into your BI. All endpoints use the /v1/openai-ads prefix and the same authentication, pagination and response format.

Getting startedCopy Anchor Link

Base URL: https://data.v4mos.ai. Every call requires your API credentials and the organizationId — see Authentication.

1. Connect OpenAI Ads in app.v4mos.ai (Connected accounts) and wait for the first sync.
2. Call any endpoint below with your organizationId, for example GET /v1/openai-ads/ad-accounts?organizationId=….
3. Every row carries integration_id and integration_name: the connected account it came from. To read a single account, pass that value as integrationId.

Available endpointsCopy Anchor Link

• getAd accounts/v1/openai-ads/ad-accountsOne row per ad account: name, status, timezone, currency and review status.
• getCampaigns/v1/openai-ads/campaignsOne row per campaign: status, mode, objective, bidding and budget limits (in micros).
• getAd groups/v1/openai-ads/ad-groupsOne row per ad group: status and bidding configuration (max bid in micros).
• getAds/v1/openai-ads/adsOne row per ad: status, review status and creative (title, body, target URL, image).
• getCampaign insights/v1/openai-ads/campaign-insightsOne row per campaign per day: impressions, clicks, spend and conversions.
• getCampaign conversion insights/v1/openai-ads/campaign-conversion-insightsOne row per campaign per day: conversions split into click-through and view-through, and attributed sales.
• getAd group insights/v1/openai-ads/ad-group-insightsOne row per ad group per day: impressions, clicks, spend and conversions.
• getAd insights/v1/openai-ads/ad-insightsOne row per ad per day: impressions, clicks, spend and conversions.

ResourcesCopy Anchor Link

Pagination and filtersCopy Anchor Link

• page (default 1) and limit (default 500, max 5000). meta.hasNextPage says whether another page exists; rows come in a stable order, so walk the pages until it is false.
• dateFrom / dateTo (YYYY-MM-DD, inclusive) filter by the date column shown in the table above. Resources without one reject them.
• integrationId keeps the rows of one connected account.
• Answers are cached for 30 minutes and the data is synced once a day — see Data sync.

Response formatCopy Anchor Link

{
  "data": [{ "...": "one object per row, with the columns listed on each endpoint" }],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Amounts and large counters (fields with format: decimal or format: int64 in each endpoint schema) come as strings, e.g. "125.50", so no precision is lost. Convert them to a decimal type on your side.