/v1/measures/, and shares two routing arguments:
subject: what the question is about. Use an appropriate ID fromresolve(spt:,gpc:,brand:,retailer:,entity:), or a plain name when the split supports it. Some splits require explicit route parameters instead; omitsubjectin that case. Do not sendsubjectand its equivalent route parameter together.by: how the answer is split. Each measure has a default, sobyis optional.
country, retailer, window, …). The direct routes (such as /v1/shopper/best-price) can also be called on their own. Each split still needs the underlying route’s required parameters. The answer is that endpoint’s answer, unchanged, and the X-Syntalic-Preset response header names the endpoint that answered.
List the measures (free)
default_by, and every by split: what it answers, which endpoint answers it, which subject kinds it takes, and an example request. No payment. It always shows which splits are available right now, so check it if a split on this page returns 404.
The eleven measures
What each split answers, split by split, is on the MCP tools page and in the free listing above. See Measures in the API Reference tab for the current parameter schemas.
Rules
- One price per measure. A
/v1/measures/*path costs the measure’s price whicheverbyyou pick. Some splits are answered by a cheaper endpoint:pricesbybrandis/v1/marketing/price-positioningat $0.01. Call that endpoint directly to pay its own price. The MCP tools do this for you. trendbyperiodis a product’s price history or a brand’s day-by-day tracker. Say which with anentity:orbrand:id, or the matching parameter (q,brand). A shelf’s price movement isby=product, the biggest movers.- Refused before billing. Unknown or ambiguous splits and incompatible subjects return
400; a split that is temporarily unavailable returns404. Both are refused before payment. Two splits are currently unavailable:trendbyperiodfor a shelf (price inflation) andneighborsbysimilar(similar brands). - Use the right scope.
neighborsandcoveragetake IDs;resolvebygpc_attributesorgpc_browse_nodestakes a GPC code. Forattentionbyweekuse an ID or the route’ssubject_kindandsubject; forassortmentbyretaileruse a suitable ID or explicitbrand/category.
Examples
These are relative GET paths, not shell commands. Prefix each withhttps://api.syntalic.com and use a paid HTTP client.