Skip to main content
GET
What sits next to an id.

Query Parameters

subject
string

What the question is about: an id (spt:, gpc:, brand:, retailer:, entity:) or a name. It is sent to the answering route as the parameter of its kind (an spt: id as spt, a brand: id as brand_id, a name as the route's name parameter), so send it OR that parameter, not both. Which kinds a split takes is in x-syntalic-presets; a kind it does not take is refused before anything is billed.

by
enum<string>
default:relations

How the answer is split. Each value is answered by one existing route; see x-syntalic-presets.

Available options:
relations
id
string

An id from resolve: spt:…, gpc:…, brand:… or retailer:….

Pattern: ^(spt|gpc|brand|retailer):.+$
relations
string

Comma-joined or repeated: which blocks to return. category: ancestors, children, siblings, types, parallel_homes, aliases, top_brands, top_retailers, facets, labels (only when named). product_type: ancestry, homes, siblings, aliases. brand: profile, aliases, footprint, carried_at, not_observed_at, similar. retailer: profile, assortment, brands. A brand's similar is { status, basis, items, total, truncated, n_entities, best_score, weak, reason }: up to 10 brands that share its shelves (four levels deep) at a similar price tier, best first, each with rank, score, overlap, price_gap and the shared shelves behind it; status: unavailable means the table is not published yet, which is not the same as no list. n_entities is the brand's distinct products on shelves (the number the floor of 5 tests), best_score the best match's score, and weak the one rule for a list that cannot be leaned on: the best score is under 0.3 or fewer than 3 brands cleared (an empty list is weak). When items is empty, reason says why: homonym (one id for two companies: no peers by design), not_a_brand (a storefront phrase in the brand field), no_footprint (no product on a shelf), below_floor (under 5 distinct products on shelves) or no_overlap (enough products, no brand shares 0.2 of its shelves). The four fields are null until the status table is published. It never uses a brand's own description, and shelves alone cannot tell two brands apart that sell the same things at the same price. An unknown one is a 400 that lists the valid ones for the kind.

limit
integer
default:25

Most items in each list. Over the maximum is a 400, not a silent clamp, so a capped list is never mistaken for the whole one.

Required range: 1 <= x <= 200
country
enum<string>
default:us

Coverage is per country, so a typo is a 400 rather than a quiet read of the other one.

Available options:
us,
ca

Response

The answer of the route that by selected, unchanged. The X-Syntalic-Preset response header names that route; its own path in this document has the response schema.

The response is of type object.