🚧
This is a low level API, we recommend you to use the simple recommendation route to enable easy configuration via the Merchant Dashboard.
Get the list of the trending items.
You can pass an array of rules to the widget to filer widget results.
An example of rules object for different types of data:
[{
type: 'text',
name: 'brand',
values: [{value: ['Some-Test-Brand']}, {value: ['Some-Other-Brand']}]
}, {
type: 'range',
name: 'price',
values: [{from: 10}, {to: 20}, {from: 10, to: 20}]
}, {
type: 'category',
name: 'category',
values: [{value: ['Top-Level']}, {value: ['Top-Level', 'Second-level']}]
}]
Body Paramst_clientdate-timerequireduserobjectrequireduser objectuidstringrequired
max length: 32 characters
sidstringrequired
max length: 32 characters
emailstringipstringuastringlangarray of stringsADD stringoffsetint32Defaults to 0limitint32Defaults to 5
max = 24
callbackstringlogbooleanlabelstring
Optional recommendation label (by providing this parameter you'll be able to view analytcs info in Merchant Dashboard for this recommendation widget)
rulesarray
Rules to filter recommendation results
Responses
200
200
Response bodyobjectmetaobjectlimitintegerDefaults to 0offsetintegerDefaults to 0user_idstringtotalintegerDefaults to 0ridstringitemsarray of objectsobjectproduct_urlstringvariants_idsarray of stringsdescriptionstringdiscountarray of integerscreated_atstringavailabilitybooleanDefaults to truetitlestringthumbnail_urlstringpricearray of numbersstickersobjectstickers objectidstringskuarray of stringsbrandstringquantityintegerDefaults to 0color_variantsintegerDefaults to 0image_urlstringcustom_fieldsobjectrating_scoreintegerDefaults to 0tagsarray of stringscategoryarray of objectsobjectcategory1stringcompare_atintegerDefaults to 0
Shell
curl --request POST --url https://api-v3.findify.io/v3/recommend/items/trending --header "X-Key: 2e963f3e-38bd-4c00-9636-c00e48945eb7" --header "Content-Type: application/json" --data '{"user":{"lang":["en-GB"],"uid":"test1","sid":"ssid","email":"test@test .com","ip":"192.168.0.1","ua":"Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"},"t_client":1484742065791,"offset":0,"limit":5,"log":false,"label":"trending-recommendation}'
Javascript Default
//Please, don't forget to include the SDK script
//Which you can find here: https://github.com/findify/javascript-sdk
var client = FindifySDK.init({
key: '2e963f3e-38bd-4c00-9636-c00e48945eb7',
user: {
uid: 'test1',
sid: 'ssid',
email: 'test@test .com'
},
log: false
});
var request = {
offset: 0,
limit: 5,
label: 'trending-recommendation'
};
client.recommendations('trending', request).then(function (response) {
console.log(response);
});
Javascript Node
var request = require("request");
var options = {
method: 'POST',
headers: {
"X-key": "2e963f3e-38bd-4c00-9636-c00e48945eb7"
},
url: 'https://api-v3.findify.io/v3/recommend/items/trending',
body: {
user: {
lang: ['en-GB'],
uid: 'test1',
sid: 'ssid',
email: 'test@test .com',
ip: '192.168.0.1',
ua: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
},
t_client: 1484742065791,
offset: 0,
limit: 5,
log: false,
label: 'trending-recommendation'
},
json: true
};
request(options, function(error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
PHP
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Key', '2e963f3e-38bd-4c00-9636-c00e48945eb7');
$api_instance = new Swagger\Client\Api\DefaultApi();
$recommendation = new \Swagger\Client\Model\GenericRecommendationRequest(array(
'user' => array(
'uid' => 'test1',
'sid' => 'ssid',
'email' => 'test@test .com',
'ip' => '192.168.0.1',
'ua' => 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36',
'lang' => array(
'en-US',
'en-GB',
'no'
)
),
't_client' => '1484741395471',
'offset' => 0,
'limit' => 5,
'log' => false,
'label' => 'trending-recommendation'
));
try {
$result = $api_instance->recommendItemsTrendingPost($recommendation);
echo $result;
}
catch (Exception $e) {
echo 'Exception when calling DefaultApi->recommendItemsTrendingPost: ', $e->getMessage(), PHP_EOL;
}
?>