personalizer.io Documentation

Help Page Home

GET v1/YouMayLike?excludedItemIdentifiers={excludedItemIdentifiers}&limit={limit}&fields={fields}&fallbackToRelatedItemIdentifierS={fallbackToRelatedItemIdentifierS}&fallbackToPopular={fallbackToPopular}&trackerReference={trackerReference}

Returns the You May Like Items

Request Information

URI Parameters

NameTypeDescriptionComments
excludedItemIdentifiers string

Comma-separated list of Item Identifier(s) to exclude from results (e.g. Item that is already being displayed).

Optional

limit integer

Number of results requested.

Optional - Default: 20

fields string

Comma-separated list of fields to include in the response.

Optional - Default: "Identifier"

fallbackToRelatedItemIdentifierS string

Comma-separated list of Item Identifier(S) for which "related items" should be returned when results are empty.

Optional

fallbackToPopular boolean

Whether or not Most Popular items should be returned when results are empty.

Optional - Default: false

host HostPage

Host Page on which the recommendations will be rendered.

trackerReference string

Additional tracker reference data.

Optional

Body Parameters

None.

Response Information

Resource Description

A list of popular items.

Collection of Item
NameTypeDescriptionComments
Identifier string

Item's unique identifier in its source system.

Required

Title string

Title.

Vendor string

ItemType string

Item type.

Price decimal number

Price (if applicable).

OriginalPrice decimal number

Original Price (if applicable, and the "Price" is discounted).

DisplayUrl string

URL by which the Item is accessible (if applicable).

Description string

Description.

ImageUrl string

Image URL (if applicable).

Prevalence integer

Indicates the relative frequency with which an item appears.

Value must be between -5 and 5

CollectionPrevalence integer

Indicates the relative frequency with which a collection appears.

Value must be between -5 and 5

PopularityIndex integer

Overall popularity index calculated based on user behavior feedback.

Read only

TrendingIndex integer

Tags string

Comma-separated tags applicable to the item.

Active boolean

Indicates whether item is active or not.

Default is true

Collections Collection of string

List of collection identifiers this item belongs to.

UpdateDate date

Latest update date.

Response Formats

application/json, text/json

Sample:
[
  {
    "Identifier": "sample string 1",
    "Title": "T-Shirt",
    "Vendor": "Nike",
    "Description": "Sample T-Shirt",
    "Prevalence": 0,
    "PopularityIndex": 2,
    "Tags": "Tee,Shirt,T-Shirt"
  },
  {
    "Identifier": "sample string 2",
    "Title": "Shoe",
    "Vendor": "Adidas",
    "Description": "Sample Shoe",
    "Prevalence": 0,
    "PopularityIndex": 1,
    "Tags": "Footwear,Shoe"
  }
]