Skip to main content
GET
How much evidence stands behind 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:evidence

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

Available options:
evidence
id
string[]

An id from resolve. Repeat the parameter for a batch (id=a&id=b), at most 25; ids=a,b is refused.

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

Narrows a brand's coverage to one chain: seen there, scanned and not seen, or not scanned. Needs at least one brand id.

Pattern: ^retailer:[a-z0-9]{1,64}$
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.