Changelog
The changelog summarizes the updates and enhancements made to the Carrot Ads API. The most recent changes are listed first. All changes are non-breaking changes.
October 10, 2025
- Added clarification on how ad impressions are calculated for both sponsored products and display banners. For more information, see Sponsored products and Display placements.
May 21, 2025
- Added the BrandPage event to the Track ad events endpoint.
May 1, 2025
- Added the
tracking_paramfield to the BrandPage object in the Get a brand page response. - Updated the Track ad events endpoint to correct some of the required fields:
- In the FeaturedProductEventProperties object,
object_tracking_idis required. - In the DisplayBannerEventProperties object,
object_tracking_id,record_version,event_id, andinteraction_idare required. - In the ShoppableDisplayEventData object,
interaction_idis required. - In the ShoppableVideoEventData object,
interaction_idis required. - In the ShoppableDisplayItemEventData object,
interaction_idis required. - In the ShoppableVideoItemEventData object,
interaction_idis required.
- In the FeaturedProductEventProperties object,
February 18, 2025
- Updated the endpoint documentation:
- Removed information about user tokens. Retailers must use client tokens only.
- In the SessionContext object and the EventTrackingContext object, updated the
user_id,user_ip, anduser_agentfields to be required. - In the FeaturedProductEventProperties object, removed the
rrcandupcfields, added theproduct_idfield, and clarified the descriptions for thepageandrecord_versionfields. - In the FilterQuery object, clarified that the catalog inventory file must contain the filters and product tags you want to use with Carrot Ads requests.
- Added the Filters and catalog identifiers topic.
- Update other concepts to include image sizes for ads assets.
October 25, 2024
- Removed the
currencyfield from the OrderProperties object in the Ingest orders request.
October 16, 2024
- Updated the Brand page topic with examples of brand page blocks.
Sept 19, 2024
- Corrected the Ads domain in all request examples from
connect.instacart.comtoconnect-ian.instacart.com.
August 1, 2024
- Added
rrcandupcfields to the ItemCard object in the Get display placements response.
June 7, 2024
- Added the following endpoints:
March 18, 2024
- Published this documentation site.