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

Title string

Vendor string

ItemType string

Price decimal number

OriginalPrice decimal number

DisplayUrl string

Description string

ImageUrl string

Prevalence integer

CollectionPrevalence integer

PopularityIndex integer

TrendingIndex integer

Tags string

Active boolean

Collections Collection of string

UpdateDate 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"
  }
]