Skip to main content
A measure is one kind of question: who sells a product and at what price, how prices moved, who holds the shelf, who is talking about it. Each measure is one priced path under /v1/measures/, and shares two routing arguments:
  • subject: what the question is about. Use an appropriate ID from resolve (spt:, gpc:, brand:, retailer:, entity:), or a plain name when the split supports it. Some splits require explicit route parameters instead; omit subject in that case. Do not send subject and its equivalent route parameter together.
  • by: how the answer is split. Each measure has a default, so by is optional.
Each split is answered by one of the existing endpoints, and every other parameter is that endpoint’s own (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)

Returns each measure with its summary, price, 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 whichever by you pick. Some splits are answered by a cheaper endpoint: prices by brand is /v1/marketing/price-positioning at $0.01. Call that endpoint directly to pay its own price. The MCP tools do this for you.
  • trend by period is a product’s price history or a brand’s day-by-day tracker. Say which with an entity: or brand: id, or the matching parameter (q, brand). A shelf’s price movement is by=product, the biggest movers.
  • Refused before billing. Unknown or ambiguous splits and incompatible subjects return 400; a split that is temporarily unavailable returns 404. Both are refused before payment. Two splits are currently unavailable: trend by period for a shelf (price inflation) and neighbors by similar (similar brands).
  • Use the right scope. neighbors and coverage take IDs; resolve by gpc_attributes or gpc_browse_nodes takes a GPC code. For attention by week use an ID or the route’s subject_kind and subject; for assortment by retailer use a suitable ID or explicit brand/category.

Examples

These are relative GET paths, not shell commands. Prefix each with https://api.syntalic.com and use a paid HTTP client.