Similar Items Based Hybrids

These are Similar Item based endpoints that have been configured with fall-throughs in case one tactic does not have a result. The fall through behaviour can be seen in the Tactic Cascade description.

Viewed Together + Similar Attributes Hybrid Recommender

GET /1.0/ClientRecom/{websiteId}/ViewedTogetherAttributes?productRef={refId}

This is a hybrid tactic meaning if there are no results for the first tactic, the recommender will try the next one. This fall-through will continue through all the tactics until a result is found. Tactic Cascade: ‘Collaborative Filtering Jaccard Items Viewed Together’ >> ‘Similar Attributes’ >> ‘Popular Items’

Path Parameters

Name	Type	Description
websiteId	string	Your website ID provided to you by PA

Query Parameters

Name	Type	Description
refId	string	The product identifier of the product being viewed.

200 A successful response will include, in the payload, an ordered list of product identifiers

{
    "payload": ["1234", "5678", "9012"],
    "type": 1,
    "code": 0
}

Viewed Together + Visually Similar Hybrid Recommender

GET /1.0/ClientRecom/{websiteId}/ViewedTogetherVisuallySimilar?productRef={refId}&productStyleId={styleId}

This is a hybrid tactic meaning if there are no results for the first tactic, the recommender will try the next one. This fall-through will continue through all the tactics until a result is found. Tactic Cascade: ‘Collaborative Filtering Jaccard Items Viewed Together’ >> ‘Visually Similar’ >> ‘Popular Items’

Path Parameters

Name	Type	Description
websiteId	string	Your website ID provided to you by PA

Query Parameters

Name	Type	Description
styleId	string	ProductStyleId being viewed. Required if the website is configured to use StyleId for VSR
refId	string	ProductRef being viewed

200 A successful response will include, in the payload, an ordered list of product identifiers

{
    "payload": ["1234", "5678", "9012"],
    "type": 1,
    "code": 0
}

Similar Attributes + Viewed Together Hybrid Recommender

GET /1.0/ClientRecom/{websiteId}/SimilarAttributesViewedTogether?productRef={refId}

This is a hybrid tactic meaning if there are no results for the first tactic, the recommender will try the next one. This fall-through will continue through all the tactics until a result is found. Tactic Cascade: ‘Similar Attributes’ >> ‘Collaborative Filtering Jaccard Items Viewed Together’ >> ‘Popular Items’

Path Parameters

Name	Type	Description
websiteId	string	Your website ID provided to you by PA

Query Parameters

Name	Type	Description
refId	string	ProductRef being viewed

200 A successful response will include, in the payload, an ordered list of product identifiers

{
    "payload": ["1234", "5678", "9012"],
    "type": 1,
    "code": 0
}

Visually Similar + Viewed Together Hybrid Recommender

GET /1.0/ClientRecom/{websiteId}/VisuallySimilarViewedTogether?productRef={refId}&productStyleId={styleId}

This is a hybrid tactic meaning if there are no results for the first tactic, the recommender will try the next one. This fall-through will continue through all the tactics until a result is found. Tactic Cascade: ‘Visually Similar’ >> ‘Collaborative Filtering Jaccard Items Viewed Together’ >> ‘Popular Items’

Path Parameters

Name	Type	Description
websiteId	string	Your website ID provided by PA

Query Parameters

Name	Type	Description
styleId	string	ProductStyleId being viewed. Required if the website is configured to use StyleId for VSR
refId	string	ProductRef being viewed

200 A successful response will include, in the payload, an ordered list of product identifiers

{
    "payload": ["1234", "5678", "9012"],
    "type": 1,
    "code": 0
}