Skip to main content
GET
/
v1
/
analyst
/
retailer-index
Price index for a specific retailer over time
curl --request GET \
  --url https://api.syntalic.com/v1/analyst/retailer-index \
  --header 'Content-Type: application/json' \
  --data '
{
  "retailer": "amazon",
  "country": "us",
  "category": "electronics",
  "category_id": 1,
  "department": "Electronics",
  "from": "2026-04-01",
  "to": "2026-05-01"
}
'
{}

Query Parameters

​
retailer
string
required

Retailer name (e.g., amazon, walmart)

​
country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
​
category
string

Product category (e.g., electronics, grocery, beauty). Fuzzy human-readable input — the resolver maps it through tier 1-4 (id → exact name → trigram → embedding kNN) to a canonical category_id. Pair with category_id if you have a deterministic id from a prior call.

Minimum string length: 1
​
category_id
integer

Deterministic category id. When set, bypasses the fuzzy resolver cascade and uses tier 1 (id lookup) directly. Agents that learned a canonical id from a prior call's resolved.category_id should pin it here for round-trip stability.

Required range: x >= 1
​
department
string

Coarse depth-1 BrowseNodes department label (e.g., 'Electronics', 'Grocery', 'Toys & Games'). Exact-match, case-sensitive Title Case. Optional alongside category; either parameter alone or both together are accepted. Use this for stable cross-agent queries where the leaf-level category is too noisy.

Minimum string length: 1
​
from
string<date>

Start date (ISO 8601, defaults to 30 days ago)

​
to
string<date>

End date (ISO 8601, defaults to now)

Body

application/json

Query parameters as JSON (alternative to URL query string for agents that prefer body-based invocation).

​
retailer
string
required

Retailer name (e.g., amazon, walmart)

Example:

"amazon"

​
country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
Example:

"us"

​
category
string

Product category (e.g., electronics, grocery, beauty). Fuzzy human-readable input — the resolver maps it through tier 1-4 (id → exact name → trigram → embedding kNN) to a canonical category_id. Pair with category_id if you have a deterministic id from a prior call.

Minimum string length: 1
Example:

"electronics"

​
category_id
integer

Deterministic category id. When set, bypasses the fuzzy resolver cascade and uses tier 1 (id lookup) directly. Agents that learned a canonical id from a prior call's resolved.category_id should pin it here for round-trip stability.

Required range: x >= 1
Example:

1

​
department
string

Coarse depth-1 BrowseNodes department label (e.g., 'Electronics', 'Grocery', 'Toys & Games'). Exact-match, case-sensitive Title Case. Optional alongside category; either parameter alone or both together are accepted. Use this for stable cross-agent queries where the leaf-level category is too noisy.

Minimum string length: 1
Example:

"Electronics"

​
from
string<date>

Start date (ISO 8601, defaults to 30 days ago)

Example:

"2026-04-01"

​
to
string<date>

End date (ISO 8601, defaults to now)

Example:

"2026-05-01"

Response

Retailer index data

The response is of type object.