Skip to main content
POST
Target product recommendations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
product
string
required

Product (TCIN or URL). e.g. 86216189

max_items
integer
default:25

Max items (up to 500)

Required range: 1 <= x <= 500
start_page
integer

Starting page

Required range: x >= 1
type
enum<string>

Recommendation type. Options: alternatives = Alternatives, also_viewed = Guests also viewed, complementary = Complementary, deals = Deals, top_performing = Top performing, newness = New arrivals, similar = Similar

Available options:
alternatives,
also_viewed,
complementary,
deals,
top_performing,
newness,
similar

Response

Run completed.

session_id
string

Session identifier for this run.

kind
string

Data source identifier for this endpoint.

product
string
product_id
string
type
string
max_items
integer
start_page
integer
partial
boolean

True when the scrape stopped early and returned the records collected so far.

human
string

Markdown summary of the result, for display.

machine
object

Structured result payload.

total_points
integer

Points charged for this run.