Skip to main content
Glama

Get PPC Data for a Rank Radar

get_rank_radar_ppc_data
Read-only

Retrieve 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

TableJSON Schema
NameRequiredDescriptionDefault
endDateYesEnd 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.
pageSizeNoKeywords per page (max 100). Defaults to 20.
startDateYesStart date of the range, yyyy-mm-dd (e.g. 2024-03-26).
currentPageNoPage of keywords, 1-indexed. Defaults to 1.
rankRadarIdYesThe Rank Radar UUID (from `list_rank_radars`).
includeCampaignsNoWhen 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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.16.1

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint=true, and the description goes well beyond that: it discloses the 90-day range cap and that <=30 days stays fast, null/0 semantics when a seller runs no ads, paused keywords being excluded, rate limiting (~60 req/min), that each call counts toward API usage, and full pagination mechanics. This is rich behavioral context layered on top of the safety annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The passage is long but front-loaded with the trigger and densely informative, with each sentence carrying constraint, semantics, or pagination detail. Slightly heavy for a single block, but nearly every sentence earns its place with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description compensates by enumerating the returned metrics, explaining null/0 cases, and detailing pagination fields (currentPage, pageSize, total, hasNext, hasPrev). Combined with rate-limit and alternative-tool guidance, an agent has everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so a baseline of 3 applies, but the description adds genuine meaning: it frames startDate/endDate with the 90-day/30-day constraint, explains includeCampaigns' purpose and when to enable it, and recommends pageSize 100 plus currentPage+1 paging for large Radars. It goes beyond restating schema text.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('advertising (Sponsored Products) performance for the keywords of a Rank Radar') and scopes it to the keywords of a specific Rank Radar, which distinguishes it from the sibling list_ppc_campaigns. An agent can tell exactly what it returns without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Opens with explicit trigger ('Use this when the user asks about advertising performance for the keywords of a Rank Radar'), names the contrasting alternative ('For the seller's campaigns as a whole, use list_ppc_campaigns'), and gives the prerequisite ('Use after list_rank_radars to discover a rankRadarId'). When-to-use, when-not, and ordering are all covered.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.