Get PPC Data for a Rank Radar
get_rank_radar_ppc_dataRetrieve Sponsored Products PPC metrics for Rank Radar keywords over a date range, including spend, sales, ACOS, ranks, and optional campaign-level breakdown.
Instructions
Use this when the user asks about advertising (Sponsored Products) performance for the keywords of a Rank Radar. Requires startDate and endDate (yyyy-mm-dd), at most 90 days apart; 30 days or less keeps it fast. Each keyword's metrics are aggregated over the range: sponsoredRank (median; 101 means not in the top 100 sponsored results), impressionRank and impressionRankShare; how many exact, phrase, broad and auto campaigns target it; organicSales, ppcSales, ppcSpend, costPerClicks, clickThroughRate, conversionRate, totalClicks, totalImpressions, totalOrders and acos. Metrics are null or 0 when the seller runs no ads on a keyword. Set includeCampaigns for the per-campaign breakdown. Results are paged by keyword: data holds one page, and the response carries currentPage, pageSize, total, lastPage, hasNext and hasPrev. total is the Rank Radar's active keyword count; to read every keyword, call again with currentPage + 1 while hasNext is true, using pageSize 100 for large Rank Radars. Paused keywords are not included. Each call counts toward API usage and is rate limited (about 60 requests/minute). For the seller's campaigns as a whole, use list_ppc_campaigns. Use after list_rank_radars to discover a rankRadarId.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endDate | Yes | End date of the range, yyyy-mm-dd (e.g. 2024-04-26). Must be on or after startDate, and at most 90 days after it. | |
| pageSize | No | Keywords per page (max 100). Defaults to 20. | |
| startDate | Yes | Start date of the range, yyyy-mm-dd (e.g. 2024-03-26). | |
| currentPage | No | Page of keywords, 1-indexed. Defaults to 1. | |
| rankRadarId | Yes | The Rank Radar UUID (from `list_rank_radars`). | |
| includeCampaigns | No | When true, each keyword also carries `campaigns`: the per-campaign/ad-group breakdown (campaign and ad group name, match type, targeting, spend, sales, clicks, impressions, orders, CPC, CTR, CVR, ACOS). Defaults to false; leave it off unless the user asks which campaigns drive a keyword. |