Shopping & Ads
Commercial surfaces inside AI answers: the product cards models return, the paid placements that run alongside them, and the local businesses they list for prompts with local intent. Shopping and ads need the Scale plan or above; local businesses are available on every plan. The endpoints are named for what they measure rather than for the assistant that first returned it, so narrow with model instead of reading the provider out of the path.
GET/dimensions/shopping
Product cards returned inside AI answers. view=products (default) returns one row per distinct product, merged across executions, with its appearance count, price range, rating and whether it is yours. view=merchants returns one row per selling merchant. A product is identified by its external product id, falling back to its title when the provider does not send a usable one, so the same product merges across executions instead of splitting into one row per answer.
project_idrequiredviewproducts|merchantsownedqueryorderproducts:appearances,price,rating,title; merchants:appearances,products,avg_price,avg_rating,merchantdirectionmodelcollection_idcountry_codelanguage_codepromptprompt_typebrand_kindrangefromtopageper_pageoutput
Every response also carries a totals block matching the KPI cards in the app.
GET/dimensions/ads
Paid placements returned inside AI answers. view=advertisers (default) returns one row per advertising domain with its placement count, prompt reach, average and best position. view=ads returns the individual placements with title, snippet, position and the prompt that triggered them. Position 1 is the best slot, so a lower average position is better.
project_idrequiredviewadvertisers|adsownedqueryorderadvertisers:ads,prompts,avg_position,domain; ads:recent,oldest,positiondirectionadvertisers only;avg_positionanddomaindefault to ascendingmodelcollection_idcountry_codelanguage_codepromptprompt_typebrand_kindrangefromtopageper_pageoutput
GET/dimensions/local_businesses
Local businesses (shops, restaurants, services) listed inside AI answers, one row per business. A business is its name at its address, so two locations of a chain are two rows. Each row carries its appearance count, the number of prompts that listed it, its average rating and average position in the list, its review count, and whether it is yours or a tracked competitor. Available on every plan.
project_idrequiredownedqueryname or addressorderappearances,business,rating,reviews,avg_position,promptsdirectionmodelcollection_idcountry_codelanguage_codepromptprompt_typebrand_kindrangefromtopageper_pageoutput
Every response also carries a totals block matching the KPI cards in the app.