personalizer.io Documentation

Help Page Home

GET v1/Popular?collectionIdentifier={collectionIdentifier}&itemIdentifier={itemIdentifier}&excludedItemIdentifier={excludedItemIdentifier}&limit={limit}&fields={fields}&trackerReference={trackerReference}

Returns the Most Popular Items

Request Information

URI Parameters

NameTypeDescriptionComments
collectionIdentifier string

Collection identifier for which you want to optionally limit the results within.

Optional

itemIdentifier string

Item identifier for collection(s) of which you want to optionally limit the results within.

Optional

excludedItemIdentifier string

Identifier of the item 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"

host HostPage

Host Page on which the recommendations will be rendered.

hostBoxType BoxType

trackerReference string

Additional tracker reference data.

Optional

Body Parameters

None.

Response Information

Resource Description

A list of popular items.

RecommendationDetails
NameTypeDescriptionComments
ReferenceID integer

BoxTitle string

Items Collection of Item

Response Formats

application/json, text/json

Sample:
{
  "ReferenceID": 1,
  "BoxTitle": "sample string 1",
  "Items": [
    {
      "ID": 1,
      "SubscriberID": 1,
      "Nature": "Product",
      "Identifier": "sample string 1",
      "Title": "sample string 2",
      "Vendor": "sample string 3",
      "ItemTypeID": 1,
      "ItemType": "sample string 4",
      "Price": 1.0,
      "OriginalPrice": 1.0,
      "DisplayUrl": "sample string 5",
      "HtmlContent": "sample string 6",
      "Description": "sample string 7",
      "ImageUrl": "sample string 8",
      "Prevalence": 1,
      "CollectionPrevalence": 1,
      "PopularityIndex": 1,
      "TrendingIndex": 1,
      "Attributes": [
        {
          "Title": "sample string 1",
          "Values": [
            {
              "Title": "sample string 1",
              "Parameters": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "Title": "sample string 1",
              "Parameters": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ]
        },
        {
          "Title": "sample string 1",
          "Values": [
            {
              "Title": "sample string 1",
              "Parameters": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "Title": "sample string 1",
              "Parameters": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ]
        }
      ],
      "Tags": "sample string 9",
      "Active": true,
      "Deleted": true,
      "CollectionCount": 1,
      "Collections": [
        "sample string 1",
        "sample string 2"
      ],
      "CollectionIDs": [
        1,
        2
      ],
      "ExtraAutoTargetKeywords": [
        "sample string 1",
        "sample string 2"
      ],
      "TargetingRules": [
        {
          "TargetingRuleID": 1,
          "Effect": "None",
          "Auto": true
        },
        {
          "TargetingRuleID": 1,
          "Effect": "None",
          "Auto": true
        }
      ],
      "TargetedKeywords": [
        {
          "KeywordID": 1,
          "Auto": true
        },
        {
          "KeywordID": 1,
          "Auto": true
        }
      ],
      "VersionDate": "2018-05-21T20:54:11.2770787+00:00",
      "UpdateDate": "2018-05-21T20:54:11.2770787+00:00"
    },
    {
      "ID": 1,
      "SubscriberID": 1,
      "Nature": "Product",
      "Identifier": "sample string 1",
      "Title": "sample string 2",
      "Vendor": "sample string 3",
      "ItemTypeID": 1,
      "ItemType": "sample string 4",
      "Price": 1.0,
      "OriginalPrice": 1.0,
      "DisplayUrl": "sample string 5",
      "HtmlContent": "sample string 6",
      "Description": "sample string 7",
      "ImageUrl": "sample string 8",
      "Prevalence": 1,
      "CollectionPrevalence": 1,
      "PopularityIndex": 1,
      "TrendingIndex": 1,
      "Attributes": [
        {
          "Title": "sample string 1",
          "Values": [
            {
              "Title": "sample string 1",
              "Parameters": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "Title": "sample string 1",
              "Parameters": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ]
        },
        {
          "Title": "sample string 1",
          "Values": [
            {
              "Title": "sample string 1",
              "Parameters": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "Title": "sample string 1",
              "Parameters": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ]
        }
      ],
      "Tags": "sample string 9",
      "Active": true,
      "Deleted": true,
      "CollectionCount": 1,
      "Collections": [
        "sample string 1",
        "sample string 2"
      ],
      "CollectionIDs": [
        1,
        2
      ],
      "ExtraAutoTargetKeywords": [
        "sample string 1",
        "sample string 2"
      ],
      "TargetingRules": [
        {
          "TargetingRuleID": 1,
          "Effect": "None",
          "Auto": true
        },
        {
          "TargetingRuleID": 1,
          "Effect": "None",
          "Auto": true
        }
      ],
      "TargetedKeywords": [
        {
          "KeywordID": 1,
          "Auto": true
        },
        {
          "KeywordID": 1,
          "Auto": true
        }
      ],
      "VersionDate": "2018-05-21T20:54:11.2770787+00:00",
      "UpdateDate": "2018-05-21T20:54:11.2770787+00:00"
    }
  ]
}