API Changelog

​

Changed

• Campaign budget responses: amountRemaining, amountCarryover, and amountUsed on campaign budget objects are deprecated. On October 19, 2026, these fields will be removed from responses entirely. amount and type are unchanged. The same budget object is returned for sponsored brand campaigns. See the Get campaigns reference.

​

Changed

• Assets API collections: The five beta collection endpoints below are deprecated as of August 18, 2026. They continue to work as before until they are removed on August 27, 2026; after that date, requests to them will fail. Endpoints for individual assets are not affected. See the Assets API reference.
  • /public/v1/assets/collection (POST)
  • /public/v1/assets/collections (GET)
  • /public/v1/assets/collection/{collection-id} (GET, PATCH, DELETE)

​

Changed

• Campaigns responses: promotionType is marked as deprecated since November 21, 2024; use adFormat on campaign responses and formatProperties on bid responses instead. See the Get campaigns reference. From April 23, 2026, promotionType will be returned as null; removal from requests and responses is planned for April 30, 2026 (subject to confirmation).

​

Removed

• /public/v1/campaign-service/estimated-clicks was removed after 1 year of deprecation. It has received no traffic for 7 months.

​

Added

• /public/v1/offsite-ads/audiences/user-list endpoint for managing user list audiences in offsite ads.

​

Changed

• /v2/auctions: Added filter field with AttributesFilter schema for product attribute filtering (supports and/or operators with attributes array).

​

Changed

• /v2/auctions: Added page object to sponsored listings and banner auction requests.
• /v2/auctions/sponsored-brand: Added optional page field to request.

​

Added

• /public/v1/campaign-service/campaigns/exclusive-banner (POST) and /public/v1/campaign-service/campaigns/exclusive-banner/{campaign-id} (GET, PATCH) endpoints for exclusive banner campaign management.
• /public/v1/campaign-service/campaigns/exclusive-listing (POST) and /public/v1/campaign-service/campaigns/exclusive-listing/{campaign-id} (GET, PATCH) endpoints for exclusive listing campaign management.
• /public/v1/media-service/slots/{slot-id} endpoint with DELETE and PATCH methods for individual slot management.
• POST method added to /public/v1/offsite-ads/audiences for creating audience jobs.

​

Added

• /public/v1/campaign-service/json-templates (GET, POST) and /public/v1/campaign-service/json-templates/{json-template-id} (GET, PATCH) endpoints for managing campaign JSON templates.
• /public/v1/media-service/slots endpoint (GET, POST) for listing and creating media slots.
• /public/v1/media-service/slots/{slot-id}/fallback endpoint (DELETE) for configuring slot fallback behavior.
• /public/v1/offsite-ads/audiences endpoint (GET) for listing audiences in offsite ads.
• DELETE method added to /public/v1/campaign-service/campaigns/{campaign-id}/bids for deleting all bids.

​

Added

• /public/v1/toppie/reporting/file-reports/daily-kpis-by-product endpoint (GET) for exporting daily KPIs by product.
• /public/v1/campaign-service/campaigns/{campaign-id}/products endpoint (GET, PUT) for managing products within a campaign.
• Offsite ads public API endpoints under /public/v1/offsite-ads

​

Added

• /public/v1/toptimize/forecasting/campaign (POST), /public/v1/toptimize/forecasting/inventory (POST), and /public/v1/toptimize/forecasting/marketplace (GET) endpoints for campaign and inventory forecasting.

​

Added

• Offsite Ads beta endpoints (/v2/offsite-ads/)
• /toptimize/v1/predictions beta endpoint for CTR/CVR predictions.
• /toptimize/v1/retrieval beta endpoint for object retrieval.
• /public/v1/segment-service/segments/{segment-id}/upload endpoint (POST) for uploading segment data.
• /public/v1/campaign-service/campaigns/{campaign-id}/restrictions (GET, POST) and /public/v1/campaign-service/campaigns/{campaign-id}/restrictions/{restriction-id} (PATCH) endpoints for campaign restriction management.
• /public/v1/campaign-service/restriction-types (GET) and /public/v1/campaign-service/restriction-types/{restriction-type-id} (GET) endpoints for managing restriction type definitions.
• /public/v1/reporting-service/file-reports/scored-attribution endpoint (GET) for scored attribution file reports.
• /public/v1/reporting-service/file-reports/interactions endpoint (GET) for exporting interaction data.
• DELETE method added to /public/v1/toppie/campaigns/{campaign-id} for deleting campaigns.

​

Changed

• Events: Added missing references to display new pageview object.
• /v2/events: Added optional deviceType and channel fields for impressions, clicks, purchases, and pageviews.

​

Added

• /toptimize/v1/rank beta endpoint for ranking objects.
• /public/v1/segment-service/segments (GET, PUT) and /public/v1/segment-service/segments/{segment-id} (DELETE) endpoints for segment management.
• /public/v1/segment-service/segments/{segment-id}/signed-url endpoint (GET) for obtaining signed URLs for segment uploads.
• /public/v1/toppie/products endpoint (GET) for listing vendor products in Toppie.
• /public/v1/reporting-service/interactions endpoint (GET) for querying interaction data.
• /public/v1/toppie/account/balance endpoint (GET) for viewing account balance.
• /public/v1/toppie/account/topups endpoint (GET) for viewing account top-ups.
• /public/v1/billing-service/campaign-billing-contact endpoint (GET, PUT).
• /public/v1/billing-service/billing-contacts (GET) and /public/v1/billing-service/billing-contacts/{billing-contact-id} (GET, PUT) endpoints for marketplace-level billing contact management.
• /public/v1/billing-service/vendor-billing-contact (PUT) and /public/v1/billing-service/vendors/{external-vendor-id}/vendor-billing-contact/{billing-contact-id} (DELETE) endpoints for vendor-level billing contacts.
• PATCH method added to /public/v1/toppie/campaigns/{campaign-id} for updating campaigns.

​

Changed

• /v2/auctions/sponsored-brand: Added optional opaqueUserId and vendorId fields.
• Events: Added placement tracking example for carousel analytics.
• /v2/auctions/travel: Extended to support flights in addition to hotels.

​

Added

• /public/v1/toppie/campaigns (GET, POST) and /public/v1/toppie/campaigns/{campaign-id} (GET) endpoints for Toppie campaign management.
• /public/v1/toppie/campaigns/{campaign-id}/bids endpoint (GET) for managing campaign bids.
• Toppie reporting endpoints (/public/v1/toppie/reporting)
• /public/v1/billing-service/vendors/{external-vendor-id}/wallets (GET, POST) and /public/v1/billing-service/vendors/{external-vendor-id}/wallets/{wallet-id}/adjust (POST) endpoints for vendor wallet management.
• PATCH method added to /public/v1/catalog-search-service/catalogs/products for updating products.

​

Changed

• Events: Documented that halo attribution requires vendorId.

​

Added

• /v2/auctions/travel endpoint for hotel travel auctions.
• /v2/events/beta/link-users beta endpoint to link user accounts.
• /public/v1/reporting-service/marketplace/campaigns-kpis (GET) and /public/v1/reporting-service/marketplace/vendors-kpis (GET) endpoints for marketplace-level KPI reporting.