personalizer.io Documentation

Help Page Home

GET v1/TopPicks?limit={limit}&fields={fields}&age={age}&gender={gender}&relationshipStatus={relationshipStatus}&homeTown={homeTown}&location={location}&freeText={freeText}&interestKeywords={interestKeywords}&trackerReference={trackerReference}

Returns the Top Picks items for the current User or the supplied profile information.

Request Information

URI Parameters

NameTypeDescriptionComments
limit integer

Number of results requested.

Optional - Default: 50

fields string

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

Optional - Default: "Identifier"

age integer

Age for which Top Picks is requested.

Optional - Default: Unspecified - Use of this parameter will completely override the current authorized user's profile information

gender Gender

Age for which Top Picks is requested.

Optional - Default: Unspecified - Use of this parameter will completely override the current authorized user's profile information

relationshipStatus RelationshipStatus

Relationship Status for which Top Picks is requested.

Optional - Default: Unspecified - Use of this parameter will completely override the current authorized user's profile information

homeTown string

- Use of this parameter will completely override the current authorized user's profile information] Home Town for which Top Picks is requested.

Optional - Default: Unspecified

location string

- Use of this parameter will completely override the current authorized user's profile information] Location for which Top Picks is requested.

Optional - Default: Unspecified

freeText string

- Use of this parameter will completely override the current authorized user's profile information] Descriptive or tag-based (e.g. comma-separated) text about the person for which Top Picks is requested.

Optional - Default: Unspecified

interestKeywords string

- Use of this parameter will completely override the current authorized user's profile information] Comma-separated list of Intrest Keywords for which Top Picks is requested.

Optional - Default: Unspecified

host HostPage

- Host Page on which the recommendations will be rendered.

Optional - Default: Dynamic

trackerReference string

Additional tracker reference data.

Optional

Body Parameters

None.

Response Information

Resource Description

A list of top picked 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"
  }
]