Retrieves the content of a slot, which then can be used to perform custom server-side personalization.
Required format
with one of the following options:
Format | Description |
---|---|
html | Returns the SmartBlock selected by the Slot formatted as HTML. |
blockimage | Returns the SmartBlock selected by the Slot formatted as an image. |
dynamichtml | Returns open-time HTML. Note: Not needed for server-side personalization. |
full | Returns everything as a JSON container, with HTML inside, plus metadata. |
compact | Returns everything as a JSON container, matching items inside items, plus metadata. Useful for Recommendations, to return product IDs without the accompanying HTML. |
appjson | Returns everything as a JSON container, with HTML inside, matching items inside items, plus metadata. |
Example format responses:
<table cellspacing="0" cellpadding="0" border="0" style="width: 600px;" align="center">
<tr>
<td class="imagecontainer" data-imageindex="0" style="border-radius: 0px;
padding: 0px;
text-align: center;
background-color: #ffffff;
">
<a href target="_blank" style="text-decoration: none;">
<img src="https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExcTVtbWpmZWZ2eHhjbndva2NsYXAyaHJ3c3Nnb3c3bWloYm96NnB6biZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/xTiN0CNHgoRf1Ha7CM/giphy.gif" alt="GIF">
</a>
</td>
</tr>
</table>
<table cellspacing="0" cellpadding="0" border="0" style="width: 600px;" align="center">
<tr>
<td class="imagecontainer" data-imageindex="0" style="border-radius: 0px;
padding: 0px;
text-align: center;
background-color: #ffffff;
">
<a href="" target="_blank" style="text-decoration: none;">
<img src="https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExcTVtbWpmZWZ2eHhjbndva2NsYXAyaHJ3c3Nnb3c3bWloYm96NnB6biZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/xTiN0CNHgoRf1Ha7CM/giphy.gif" alt="GIF" />
</a>
</td>
</tr>
</table>
<table cellspacing="0" cellpadding="0" border="0" style="width: 600px;" align="center">
<tr>
<td class="imagecontainer" data-imageindex="0" style="border-radius: 0px;
padding: 0px;
text-align: center;
background-color: #ffffff;
"><a class="fr__link-wrapper"
href="https://c8.dycdn.net/rg55bjkl/s/push2dd/?k=3ldtt4d&format=dynamiclink"><img src="https://c8.dycdn.net/rg55bjkl/s/push2dd/?k=3ldtt4d&format=dynamicimage"></a>
</td>
</tr>
</table>
{
"html": "<table cellspacing=\"0\" cellpadding=\"0\" border=\"0\" style=\"width: 600px;\" align=\"center\">\n\n <tr>\n\n <td class=\"imagecontainer\" data-imageindex=\"0\" style=\"border-radius: 0px; \n padding: 0px;\n text-align: center;\n background-color: #ffffff;\n \">\n\n <a href target=\"_blank\" style=\"text-decoration: none;\">\n\n <img src=\"https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExcTVtbWpmZWZ2eHhjbndva2NsYXAyaHJ3c3Nnb3c3bWloYm96NnB6biZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/xTiN0CNHgoRf1Ha7CM/giphy.gif\" alt=\"GIF\">\n\n </a>\n\n </td>\n\n </tr>\n\n</table>",
"js": null,
"css": null,
"var": {
"tmclt": true
},
"meta": {
"tmsl": "push2dd",
"tmsb": "aa7u9zu",
"tmrl": "l0tt40i",
"tmcs": "iz2z0mg",
"tmcv": 0,
"tmty": "e",
"tmsn": "Test LS",
"products": []
}
}
{
"html": null,
"js": null,
"css": null,
"var": {},
"meta": {
"tmsl": "push2dd",
"tmsb": "aa7u9zu",
"tmrl": "l0tt40i",
"tmty": "e",
"tmsn": "Test LS"
},
"items": []
}
{
"html": "\n\n<table cellspacing=\"0\" cellpadding=\"0\" border=\"0\" style=\"width: 600px;\" align=\"center\">\n\n <tr>\n\n <td class=\"imagecontainer\" data-imageindex=\"0\" style=\"border-radius: 0px; \n padding: 0px;\n text-align: center;\n background-color: #ffffff;\n \">\n\n <a href=\"\" target=\"_blank\" style=\"text-decoration: none;\">\n\n <img src=\"https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExcTVtbWpmZWZ2eHhjbndva2NsYXAyaHJ3c3Nnb3c3bWloYm96NnB6biZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/xTiN0CNHgoRf1Ha7CM/giphy.gif\" alt=\"GIF\" />\n\n </a>\n\n </td>\n\n </tr>\n\n</table>\n",
"js": null,
"css": null,
"var": {},
"meta": {
"tmsl": "push2dd",
"tmsb": "aa7u9zu",
"tmrl": "l0tt40i",
"tmcs": "iz2z0mg",
"tmcv": 0,
"tmty": "e",
"tmsn": "Test LS",
"products": []
},
"items": []
}
Additional personalization parameters
This endpoint also supports personalization by including an identifier for the shopper in the query string parameters.
The any of the following optional query string parameters are supported:
Parameter | Description |
---|---|
e | The users email address. |
d | An identifier for a device the shopper used to visit your website. The device ID is a cookie value that is generated by our script on your website. This is stored in the tms_VisitorID cookie. This is a first-party cookie, so is available in the Cookie HTTP header on requests to your server. |
cid | The shopper's customer ID. This only works if this value is known to Fresh Relevance already. Learn more in Import person data. |
If you're using filters to return relevant content based on the specific site then you may also need to pass through additional parameters, such as:
Parameter | Description |
---|---|
prid | Unique product identifier e.g. 12345 |
sbr | Site Brand/Territory for the product (e.g. the product was shown in USD on the US version of the store) e.g. DEMO |
curr | Currency - ISO 4217 currency code e.g. USD |
Examples
Fetch HTML content for server side merging
https://c8.dycdn.net/abcdefg1/s/push2dd/?k=z321xx4d&format=html
Fetch JSON content for server side processing
https://c8.dycdn.net/abcdefg1/s/push2dd/?k=z321xx4d&format=full
Fetch JSON content for server side processing with additional personalization
https://c8.dycdn.net/abcdefg1/s/push2dd/?k=z321xx4d&format=full&[email protected]
Struggling to get the correct URL to get a slot
To find the specific URL for a Slot stored in your account:
- Go to Content > Slots.
- Select the Web Personalization tab.
- Select the Slot you want, then select the Use icon.
- The URL to request that slot is shown under Feed URL.