GET marketing/v1/Popular?collectionIdentifier={collectionIdentifier}&itemIdentifier={itemIdentifier}&excludedItemIdentifiers={excludedItemIdentifiers}&limit={limit}&fields={fields}
Returns the Most Popular Items
Request Information
URI Parameters
| Name | Type | Description | Comments |
|---|---|---|---|
| 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 |
| 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" |
| host | PageType |
Host Page on which the recommendations will be rendered. |
|
| hostBoxType | ActivitySource |
Body Parameters
None.
Response Information
Resource Description
A list of popular items.
RecommendationDetails| Name | Type | Description | Comments |
|---|---|---|---|
| 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,
"ItemTypeSource": "Platform",
"ItemTypeTitle": "sample string 4",
"ItemType": "sample string 5",
"Price": 1.0,
"OriginalPrice": 1.0,
"Cost": 1.0,
"DisplayUrl": "sample string 6",
"HtmlContent": "sample string 7",
"Description": "sample string 8",
"ImageUrl": "sample string 9",
"Prevalence": 1,
"CollectionPrevalence": 1,
"PopularityIndex": 1,
"TrendingIndex": 1,
"Attributes": [
{
"Title": "sample string 1",
"SourceType": "Platform",
"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",
"SourceType": "Platform",
"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 10",
"Active": true,
"Visible": true,
"Deleted": true,
"Collections": [
"sample string 1",
"sample string 2"
],
"CollectionIDs": [
1,
2
],
"ExtraAutoTargetKeywords": [
"sample string 1",
"sample string 2"
],
"TargetingRules": [
{
"ItemID": 1,
"TargetingRuleID": 2,
"Effect": "None",
"Auto": true,
"TargetingRuleAttributes": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
},
{
"ItemID": 1,
"TargetingRuleID": 2,
"Effect": "None",
"Auto": true,
"TargetingRuleAttributes": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
],
"TargetedKeywords": [
{
"KeywordID": 1,
"Auto": true
},
{
"KeywordID": 1,
"Auto": true
}
],
"TargetedUserSegments": [
{
"UserSegmentGuid": "5c41fed2-f5e1-4199-8c04-6c319436e01a",
"Auto": true
},
{
"UserSegmentGuid": "5c41fed2-f5e1-4199-8c04-6c319436e01a",
"Auto": true
}
],
"PublishDate": "2021-09-28T10:13:37.9713833+00:00",
"CreateDate": "2021-09-28T10:13:37.9713833+00:00",
"VersionDate": "2021-09-28T10:13:37.9713833+00:00",
"UpdateDate": "2021-09-28T10:13:37.9713833+00:00"
},
{
"ID": 1,
"SubscriberID": 1,
"Nature": "Product",
"Identifier": "sample string 1",
"Title": "sample string 2",
"Vendor": "sample string 3",
"ItemTypeID": 1,
"ItemTypeSource": "Platform",
"ItemTypeTitle": "sample string 4",
"ItemType": "sample string 5",
"Price": 1.0,
"OriginalPrice": 1.0,
"Cost": 1.0,
"DisplayUrl": "sample string 6",
"HtmlContent": "sample string 7",
"Description": "sample string 8",
"ImageUrl": "sample string 9",
"Prevalence": 1,
"CollectionPrevalence": 1,
"PopularityIndex": 1,
"TrendingIndex": 1,
"Attributes": [
{
"Title": "sample string 1",
"SourceType": "Platform",
"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",
"SourceType": "Platform",
"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 10",
"Active": true,
"Visible": true,
"Deleted": true,
"Collections": [
"sample string 1",
"sample string 2"
],
"CollectionIDs": [
1,
2
],
"ExtraAutoTargetKeywords": [
"sample string 1",
"sample string 2"
],
"TargetingRules": [
{
"ItemID": 1,
"TargetingRuleID": 2,
"Effect": "None",
"Auto": true,
"TargetingRuleAttributes": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
},
{
"ItemID": 1,
"TargetingRuleID": 2,
"Effect": "None",
"Auto": true,
"TargetingRuleAttributes": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
],
"TargetedKeywords": [
{
"KeywordID": 1,
"Auto": true
},
{
"KeywordID": 1,
"Auto": true
}
],
"TargetedUserSegments": [
{
"UserSegmentGuid": "5c41fed2-f5e1-4199-8c04-6c319436e01a",
"Auto": true
},
{
"UserSegmentGuid": "5c41fed2-f5e1-4199-8c04-6c319436e01a",
"Auto": true
}
],
"PublishDate": "2021-09-28T10:13:37.9713833+00:00",
"CreateDate": "2021-09-28T10:13:37.9713833+00:00",
"VersionDate": "2021-09-28T10:13:37.9713833+00:00",
"UpdateDate": "2021-09-28T10:13:37.9713833+00:00"
}
]
}