Added
VTEX Ads API: New endpoint for product results by campaign
1 days ago
The VTEX Ads API now offers a new operation, Get product results by campaign (GET /product/results), documented in the API Reference. It returns performance metrics for each SKU linked to a campaign, aggregated over an inclusive date range.
What has changed?
- The new operation is
GET /product/results(withcampaign_idas a query parameter), listed under theReportstag. - Each item in the response carries product identity fields, including
product_sku, which identifies the product, and performance metrics, includingimpressions,clicks, andconversions_value. - Metric values are returned as numeric strings, not as numbers.
- The
start_dateandend_dateparameters are inclusive and both default to the current date when omitted, so a call without them returns data for that date only. - Results are paginated and sorted with the
page,quantity,order_by, andorder_directionparameters. Settingcount=falsereturns a bare array of products instead of thetotal,pages,currentPage, anddataenvelope. - This operation returns results per product (SKU) for one campaign, unlike Get ads performance report, which returns results per ad across campaigns, and unlike Get campaign details, which returns campaign-level totals.
What needs to be done?
No action is required for existing integrations, because this is a new endpoint and no existing endpoint changed behavior.
To adopt it, call the operation with the campaign UUID in the campaign_id query parameter, authenticating with the same X-App-Id and X-Api-Key headers used by the other Reports endpoints.
Learn more
- Exporting ads reports guide, for general
Reportscontext. - VTEX Ads API reference.
- Get product results by campaign in the API Reference.