Create Ad Record

post

https://api.triplewhale.com/api/v2/data-in/ads

Ingest ad data into Triple Whale. This endpoint allows users to upload detailed ad information, including campaign, adset, ad details, and performance metrics.

📘
How to Update a Custom Ad Record
To update a custom ad record, resend the ad with all of the following fields exactly matching the original:
shop, channel, channel_account_id (if used), event_date, campaign.id, adset.id, ad.id,
All other fields will be overwritten with the newly sent values.

Body Params

shop

string

required

The exact Shop URL (e.g., 'example.myshopify.com'). Must match the Shop URL value shown in Settings → Store. The API key owner must also have access to the shop, otherwise the request will return 403.

channel

string

required

The advertising platform associated with the ad data. Use a Standardized Ad Channel ID or enter a custom value.

channel_account_id

string

Defaults to CUSTOM_CHANNEL

The platform-specific account ID. Maps to account_id in the Ads table.

event_date

date

required

The date of the event in local timezone. Must be a valid date string (e.g., YYYY-MM-DD).

currency

string

required

The currency used for reporting (e.g., 'USD').

campaign

object

Details of the advertising campaign. At least one of campaign, adset, or ad is required.

adset

object

Details of the adset. At least one of campaign, adset, or ad is required.

object

Details of the individual ad. At least one of campaign, adset, or ad is required.

metrics

object

Performance metrics for the ad.

updated_at

date-time

The time at which the ad record was last updated. Must be provided in ISO 8601 format, with explicit timezone information (Z or +/-HH:mm offset). Offsets are supported (e.g., 2024-11-29T12:00:00+02:00). Defaults to the current time.

Responses

How to Update a Custom Ad Record

200Ad record successfully received.

400Bad Request

429Too Many Requests

500Internal Server Error