API Reference

This section lists all the available API endpoints, that allow you to manage item catalog, users, their interactions and get recommendations.

Version: 5.0.0
Base URL: Based on the region of your database
API consumes: application/json
API produces: application/json
Authentication: HMAC (already implemented in the SDKs)

Items

The following methods allow you to maintain the set of items in the catalog. The items are specified using their ids, which are unique string identifiers matching ^[a-zA-Z0-9_-:@.]+$, i.e., they may consist of digits, Latin letters, underscores, colons, minus signs, at signs, and dots.

put

Add Item

Adds new item of the given itemId to the items catalog.

All the item properties for the newly created items are set to null.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddItem(itemId));

Copy

Initialization

client.send(AddItem(item_id))

Copy

Initialization

client.send(AddItem.new(itemId))

Copy

Initialization

client.send(new AddItem(String itemId));

Copy

Initialization

<?php
$client->send(new AddItem($item_id));
?>

Copy

Initialization

client.Send(AddItem(string itemId));

Copy

Initialization

request := client.NewAddItem(itemId string)

_, err := request.Send()

Copy

PUT /{databaseId}/items/{itemId}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item to be created.

Responses

201

Successful operation.

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$.

409

The itemId is already present in the item catalog. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete Item

Deletes an item of the given itemId from the catalog.

If there are any purchases, ratings, bookmarks, cart additions, or detail views of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some series, it will be removed from all the series where present.

If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and only exclude the item from recommendations. In such a case, use ReQL filter instead of deleting the item completely.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteItem(itemId));

Copy

Initialization

client.send(DeleteItem(item_id))

Copy

Initialization

client.send(DeleteItem.new(itemId))

Copy

Initialization

client.send(new DeleteItem(String itemId));

Copy

Initialization

<?php
$client->send(new DeleteItem($item_id));
?>

Copy

Initialization

client.Send(DeleteItem(string itemId));

Copy

Initialization

request := client.NewDeleteItem(itemId string)

_, err := request.Send()

Copy

DELETE /{databaseId}/items/{itemId}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item to be deleted.

Responses

200

Successful operation.

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$.

404

The itemId is not present in the item catalog. In many cases, you may consider this code a success – it only tells you that nothing has been deleted from the database since the item was already not present. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Items

Gets a list of IDs of items currently present in the catalog.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListItems({
  // optional parameters:
  'filter': <string>,
  'count': <integer>,
  'offset': <integer>,
  'returnProperties': <boolean>,
  'includedProperties': <array>
}))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListItems(
    # optional parameters:
    filter=<string>,
    count=<integer>,
    offset=<integer>,
    return_properties=<boolean>,
    included_properties=<array>
  )
)

Copy

Initialization

result = client.send(ListItems.new({
    # optional parameters:
    :filter => <string>,
    :count => <integer>,
    :offset => <integer>,
    :return_properties => <boolean>,
    :included_properties => <array>
  })
)

Copy

Initialization

Item[] result = client.send(new ListItems()
  .setFilter(String filter)
  .setCount(long count)
  .setOffset(long offset)
  .setReturnProperties(boolean returnProperties)
  .setIncludedProperties(String[] includedProperties)
);

Copy

Initialization

<?php
$result = $client->send(new ListItems([
    // optional parameters:
    'filter' => <string>,
    'count' => <integer>,
    'offset' => <integer>,
    'returnProperties' => <boolean>,
    'includedProperties' => <array>
  ])
);
?>

Copy

Initialization

IEnumerable<Item> result = client.Send(ListItems(
    // optional parameters:
    filter: <string>,
    count: <long>,
    offset: <long>,
    returnProperties: <bool>,
    includedProperties: <string[]>
  )
);

Copy

Initialization

request := client.NewListItems()    
    // optional parameters:
    .SetFilter(filter string)
    .SetCount(count int)
    .SetOffset(offset int)
    .SetReturnProperties(returnProperties bool)
    .SetIncludedProperties(includedProperties []string)


result, err := request.Send() // result is of the type []bindings.Item

Copy

GET /{databaseId}/items/list/?filter=<string>
&count=<integer>
&offset=<integer>
&returnProperties=<boolean>
&includedProperties=<array>

Calls Limit Per Minute

100

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

filter

string

Located in: query

Required: No

Boolean-returning ReQL expression, which allows you to filter items to be listed. Only the items for which the expression is true will be returned.

count

integer

Located in: query

Required: No

The number of items to be listed.

offset

integer

Located in: query

Required: No

Specifies the number of items to skip (ordered by itemId).

returnProperties

boolean

Located in: query

Required: No

Since version: 1.4.0

With returnProperties=true, property values of the listed items are returned along with their IDs in a JSON dictionary.

Example response:

  [
    {
      "itemId": "tv-178",
      "description": "4K TV with 3D feature",
      "categories":   ["Electronics", "Televisions"],
      "price": 342,
      "url": "myshop.com/tv-178"
    },
    {
      "itemId": "mixer-42",
      "description": "Stainless Steel Mixer",
      "categories":   ["Home & Kitchen"],
      "price": 39,
      "url": "myshop.com/mixer-42"
    }
  ]

includedProperties

array

Located in: query

Required: No

Since version: 1.4.0

Allows specifying which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list.

Example response for includedProperties=description,price:

  [
    {
      "itemId": "tv-178",
      "description": "4K TV with 3D feature",
      "price": 342
    },
    {
      "itemId": "mixer-42",
      "description": "Stainless Steel Mixer",
      "price": 39
    }
  ]

Responses

200

Successful operation.

[
  "item-1",
  "item-2",
  "item-3"
]

404

If present, filter contains a non-existing item property.

delete

Delete More Items

Deletes all the items that pass the filter.

If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful) and only exclude the item from recommendations. In such a case, use ReQL filter instead of deleting the item completely.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteMoreItems(filter))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(DeleteMoreItems(filter))

Copy

Initialization

result = client.send(DeleteMoreItems.new(filter))

Copy

Initialization

DeleteMoreItemsResponse result = client.send(new DeleteMoreItems(String filter));

Copy

Initialization

<?php
$result = $client->send(new DeleteMoreItems($filter));
?>

Copy

Initialization

DeleteMoreItemsResponse result = client.Send(DeleteMoreItems(string filter));

Copy

Initialization

request := client.NewDeleteMoreItems(filter string)

result, err := request.Send() // result is of the type bindings.DeleteMoreItemsResponse

Copy

DELETE /{databaseId}/more-items/
Body (application/json):
{
  "filter" => <string>
}

Since version

3.3.0

Calls Limit Per Minute

1000

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 3.3.0

ID of your database.

filter

string

Located in: body

Required: Yes

Since version: 3.3.0

A ReQL expression, which returns true for the items that shall be updated.

Responses

200

Successful operation.

{
  "itemIds": [
    "item-42",
    "item-125",
    "item-11"
  ],
  "count": 3
}

400

Invalid filter.

Item Properties

Item properties definition

Item properties are used for modeling your domain. The following methods allow the definition of item properties. The properties may be thought of as columns in a relational database table.

put

Add Item Property

Adding an item property is somewhat equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddItemProperty(propertyName, type));

Copy

Initialization

client.send(AddItemProperty(property_name, type))

Copy

Initialization

client.send(AddItemProperty.new(propertyName, type))

Copy

Initialization

client.send(new AddItemProperty(String propertyName, String type));

Copy

Initialization

<?php
$client->send(new AddItemProperty($property_name, $type));
?>

Copy

Initialization

client.Send(AddItemProperty(string propertyName, string type));

Copy

Initialization

request := client.NewAddItemProperty(propertyName string, type string)

_, err := request.Send()

Copy

PUT /{databaseId}/items/properties/{propertyName}?type=<string>

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

propertyName

string

Located in: path

Required: Yes

Name of the item property to be created. Currently, the following names are reserved: id, itemid, case-insensitively. Also, the length of the property name must not exceed 63 characters.

type

string

Located in: query

Required: Yes

Value type of the item property to be created. One of: int, double, string, boolean, timestamp, set, image or imageList.

int- Signed integer number.
double - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
string - UTF-8 string.
boolean - true / false
timestamp - Value representing date and time.
set - Set of strings.
image - URL of an image (jpeg, png or gif).
imageList - List of URLs that refer to images.

Responses

201

Successful operation.

400

Property name does not match ^[a-zA-Z0-9_-:]+$, or it is a reserved keyword (''id'', ''itemid''), or its length exceeds 63 characters. Type information is missing, or the given type is invalid.

409

Property of the given name is already present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete Item Property

Deleting an item property is roughly equivalent to removing a column from the table of items.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteItemProperty(propertyName));

Copy

Initialization

client.send(DeleteItemProperty(property_name))

Copy

Initialization

client.send(DeleteItemProperty.new(propertyName))

Copy

Initialization

client.send(new DeleteItemProperty(String propertyName));

Copy

Initialization

<?php
$client->send(new DeleteItemProperty($property_name));
?>

Copy

Initialization

client.Send(DeleteItemProperty(string propertyName));

Copy

Initialization

request := client.NewDeleteItemProperty(propertyName string)

_, err := request.Send()

Copy

DELETE /{databaseId}/items/properties/{propertyName}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

propertyName

string

Located in: path

Required: Yes

Name of the property to be deleted.

Responses

200

Successful operation.

400

Property name does not match ^[a-zA-Z0-9_-:]+$.

404

Property of the given name is not present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been deleted from the database since the item property was already not present. If there is no additional info in the JSON response, you probably have an error in your URL.

get

Get Item Property Info

Gets information about specified item property.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.GetItemPropertyInfo(propertyName))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(GetItemPropertyInfo(property_name))

Copy

Initialization

result = client.send(GetItemPropertyInfo.new(propertyName))

Copy

Initialization

PropertyInfo result = client.send(new GetItemPropertyInfo(String propertyName));

Copy

Initialization

<?php
$result = $client->send(new GetItemPropertyInfo($property_name));
?>

Copy

Initialization

PropertyInfo result = client.Send(GetItemPropertyInfo(string propertyName));

Copy

Initialization

request := client.NewGetItemPropertyInfo(propertyName string)

result, err := request.Send() // result is of the type bindings.PropertyInfo

Copy

GET /{databaseId}/items/properties/{propertyName}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

propertyName

string

Located in: path

Required: Yes

Name of the property about which the information is to be retrieved.

Responses

200

Successful operation.

{
  "name": "num-processors",
  "type": "int"
}

400

Property name does not match ^[a-zA-Z0-9_-:]+$.

404

Property of the given name is not present in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Item Properties

Gets the list of all the item properties in your database.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListItemProperties())
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListItemProperties())

Copy

Initialization

result = client.send(ListItemProperties.new())

Copy

Initialization

PropertyInfo[] result = client.send(new ListItemProperties());

Copy

Initialization

<?php
$result = $client->send(new ListItemProperties());
?>

Copy

Initialization

IEnumerable<PropertyInfo> result = client.Send(ListItemProperties());

Copy

Initialization

request := client.NewListItemProperties()

result, err := request.Send() // result is of the type []bindings.PropertyInfo

Copy

GET /{databaseId}/items/properties/list/

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

Responses

200

Successful operation.

[
  {
    "name": "tags",
    "type": "set"
  },
  {
    "name": "release-date",
    "type": "timestamp"
  },
  {
    "name": "description",
    "type": "string"
  }
]

404

Invalid URL.

Values of item properties

The following methods allow assigning property values to items in the catalog. Set values are examined by content-based algorithms and used for recommendations, especially in the case of cold-start items that have no interactions yet. Properties are also used in ReQL for filtering and boosting according to your business rules.

post

Set Item Values

Sets/updates (some) property values of the given item. The properties (columns) must be previously created by Add item property.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.SetItemValues(itemId, values, {
  // optional parameters:
  'cascadeCreate': <boolean>
}));

Copy

Initialization

client.send(SetItemValues(item_id, values,
    # optional parameters:
    cascade_create=<boolean>
  )
)

Copy

Initialization

client.send(SetItemValues.new(itemId, values, {
    # optional parameters:
    :cascade_create => <boolean>
  })
)

Copy

Initialization

client.send(new SetItemValues(String itemId, Map<String, Object> values)
  .setCascadeCreate(boolean cascadeCreate)
);

Copy

Initialization

<?php
$client->send(new SetItemValues($item_id, $values, [
    // optional parameters:
    'cascadeCreate' => <boolean>
  ])
);
?>

Copy

Initialization

client.Send(SetItemValues(string itemId, Dictionary<string, object> values,
    // optional parameters:
    cascadeCreate: <bool>
  )
);

Copy

Initialization

request := client.NewSetItemValues(itemId string, values map[string]interface{})    
    // optional parameters:
    .SetCascadeCreate(cascadeCreate bool)


_, err := request.Send()

Copy

POST /{databaseId}/items/{itemId}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item which will be modified.

object

Located in: body

Required: Yes

The values for the individual properties.

Example of the body:

  {
    "product_description": "4K TV with 3D feature",
    "categories":   ["Electronics", "Televisions"],
    "price_usd": 342,
    "in_stock_from": "2016-11-16T08:00Z",
    "image": "http://myexamplesite.com/products/4ktelevision3d/image.jpg",
    "other_images": ["http://myexamplesite.com/products/4ktelevision3d/image2.jpg",
                     "http://myexamplesite.com/products/4ktelevision3d/image3.jpg"]
  }

Set item values can also cascade create the item if it's not already present in the database.

For this functionality:

When using the client libraries: Set the optional cascadeCreate parameter to true, just like when creating an interaction.
When using directly REST API: Set special "property" !cascadeCreate.

Example:
```
  {
    "product_description": "4K TV with 3D feature",
    "!cascadeCreate": true
  }
```
Note the exclamation mark (!) at the beginning of the parameter's name to distinguish it from item property names.

Responses

200

Successful operation.

400

Property name does not match ''^[a-zA-Z0-9_-:]+$'', value does not match the property type.

404

Property of the given name is not present in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

Get Item Values

Gets all the current property values of the given item.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.GetItemValues(itemId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(GetItemValues(item_id))

Copy

Initialization

result = client.send(GetItemValues.new(itemId))

Copy

Initialization

Map<String, Object> result = client.send(new GetItemValues(String itemId));

Copy

Initialization

<?php
$result = $client->send(new GetItemValues($item_id));
?>

Copy

Initialization

StringBinding result = client.Send(GetItemValues(string itemId));

Copy

Initialization

request := client.NewGetItemValues(itemId string)

result, err := request.Send() // result is of the type map[string]interface{}

Copy

GET /{databaseId}/items/{itemId}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item whose properties are to be obtained.

Responses

200

Successful operation.

{
  "release-date": null,
  "tags": [
    "electronics",
    "laptops"
  ],
  "num-processors": 12,
  "description": "Very powerful laptop",
  "weight": 1.6
}

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$

404

Item of the given itemId is not present in the catalog. If there is no additional info in the JSON response, you probably have an error in your URL.

post

Update More Items

Updates (some) property values of all the items that pass the filter.

Example: Setting all the items that are older than a week as unavailable

  {
    "filter": "'releaseDate' < now() - 7*24*3600",
    "changes": {"available": false}
  }

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.UpdateMoreItems(filter, changes))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(UpdateMoreItems(filter, changes))

Copy

Initialization

result = client.send(UpdateMoreItems.new(filter, changes))

Copy

Initialization

UpdateMoreItemsResponse result = client.send(new UpdateMoreItems(String filter, Map<String, Object> changes));

Copy

Initialization

<?php
$result = $client->send(new UpdateMoreItems($filter, $changes));
?>

Copy

Initialization

UpdateMoreItemsResponse result = client.Send(UpdateMoreItems(string filter, Dictionary<string, object> changes));

Copy

Initialization

request := client.NewUpdateMoreItems(filter string, changes map[string]interface{})

result, err := request.Send() // result is of the type bindings.UpdateMoreItemsResponse

Copy

POST /{databaseId}/more-items/
Body (application/json):
{
  "filter" => <string>,
  "changes" => <Object>
}

Since version

3.3.0

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 3.3.0

ID of your database.

filter

string

Located in: body

Required: Yes

Since version: 3.3.0

A ReQL expression, which returns true for the items that shall be updated.

changes

object

Located in: body

Required: Yes

Since version: 3.3.0

A dictionary where the keys are properties that shall be updated.

Responses

200

Successful operation. Returns IDs of updated items and their count.

{
  "itemIds": [
    "item-42",
    "item-125",
    "item-11"
  ],
  "count": 3
}

400

Invalid filter, property name does not match ''^[a-zA-Z0-9_-:]+$'', value does not match the property type.

404

Property of the given name is not present in the database.

Users

The following methods allow you to manage users in your database.

put

Add User

Adds a new user to the database.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddUser(userId));

Copy

Initialization

client.send(AddUser(user_id))

Copy

Initialization

client.send(AddUser.new(userId))

Copy

Initialization

client.send(new AddUser(String userId));

Copy

Initialization

<?php
$client->send(new AddUser($user_id));
?>

Copy

Initialization

client.Send(AddUser(string userId));

Copy

Initialization

request := client.NewAddUser(userId string)

_, err := request.Send()

Copy

PUT /{databaseId}/users/{userId}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: path

Required: Yes

ID of the user to be added.

Responses

201

Successful operation.

400

The userId does not match ^[a-zA-Z0-9_-:@.]+$.

409

User of the given userId is already present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete User

Deletes a user of the given userId from the database.

If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteUser(userId));

Copy

Initialization

client.send(DeleteUser(user_id))

Copy

Initialization

client.send(DeleteUser.new(userId))

Copy

Initialization

client.send(new DeleteUser(String userId));

Copy

Initialization

<?php
$client->send(new DeleteUser($user_id));
?>

Copy

Initialization

client.Send(DeleteUser(string userId));

Copy

Initialization

request := client.NewDeleteUser(userId string)

_, err := request.Send()

Copy

DELETE /{databaseId}/users/{userId}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: path

Required: Yes

ID of the user to be deleted.

Responses

200

Successful operation.

400

The userId does not match ''^[a-zA-Z0-9_-:@.]+$''.

404

User of the given userId is not present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been deleted from the database since the user was already not present. If there is no additional info in the JSON response, you probably have an error in your URL.

put

Merge Users

Allowed on Client-Side

Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two becomes desirable.

Merging happens between two users referred to as the target and the source. After the merge, all the interactions of the source user are attributed to the target user, and the source user is deleted.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.MergeUsers(targetUserId, sourceUserId, {
  // optional parameters:
  'cascadeCreate': <boolean>
}));

Copy

Initialization

client.send(MergeUsers(target_user_id, source_user_id,
    # optional parameters:
    cascade_create=<boolean>
  )
)

Copy

Initialization

client.send(MergeUsers.new(targetUserId, sourceUserId, {
    # optional parameters:
    :cascade_create => <boolean>
  })
)

Copy

Initialization

client.send(new MergeUsers(String targetUserId, String sourceUserId)
  .setCascadeCreate(boolean cascadeCreate)
);

Copy

Initialization

<?php
$client->send(new MergeUsers($target_user_id, $source_user_id, [
    // optional parameters:
    'cascadeCreate' => <boolean>
  ])
);
?>

Copy

Initialization

client.Send(MergeUsers(string targetUserId, string sourceUserId,
    // optional parameters:
    cascadeCreate: <bool>
  )
);

Copy

Initialization

request := client.NewMergeUsers(targetUserId string, sourceUserId string)    
    // optional parameters:
    .SetCascadeCreate(cascadeCreate bool)


_, err := request.Send()

Copy

PUT /{databaseId}/users/{targetUserId}/merge/{sourceUserId}?cascadeCreate=<boolean>

Calls Limit Per Minute

100

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

targetUserId

string

Located in: path

Required: Yes

ID of the target user.

sourceUserId

string

Located in: path

Required: Yes

ID of the source user.

cascadeCreate

boolean

Located in: query

Required: No

Sets whether the user targetUserId should be created if not present in the database.

Responses

201

Successful operation.

400

The sourceUserId or targetUserId does not match ^[a-zA-Z0-9_-:@.]+$

404

The sourceUserId or targetUserId does not exist in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Users

Gets a list of IDs of users currently present in the catalog.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListUsers({
  // optional parameters:
  'filter': <string>,
  'count': <integer>,
  'offset': <integer>,
  'returnProperties': <boolean>,
  'includedProperties': <array>
}))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListUsers(
    # optional parameters:
    filter=<string>,
    count=<integer>,
    offset=<integer>,
    return_properties=<boolean>,
    included_properties=<array>
  )
)

Copy

Initialization

result = client.send(ListUsers.new({
    # optional parameters:
    :filter => <string>,
    :count => <integer>,
    :offset => <integer>,
    :return_properties => <boolean>,
    :included_properties => <array>
  })
)

Copy

Initialization

User[] result = client.send(new ListUsers()
  .setFilter(String filter)
  .setCount(long count)
  .setOffset(long offset)
  .setReturnProperties(boolean returnProperties)
  .setIncludedProperties(String[] includedProperties)
);

Copy

Initialization

<?php
$result = $client->send(new ListUsers([
    // optional parameters:
    'filter' => <string>,
    'count' => <integer>,
    'offset' => <integer>,
    'returnProperties' => <boolean>,
    'includedProperties' => <array>
  ])
);
?>

Copy

Initialization

IEnumerable<User> result = client.Send(ListUsers(
    // optional parameters:
    filter: <string>,
    count: <long>,
    offset: <long>,
    returnProperties: <bool>,
    includedProperties: <string[]>
  )
);

Copy

Initialization

request := client.NewListUsers()    
    // optional parameters:
    .SetFilter(filter string)
    .SetCount(count int)
    .SetOffset(offset int)
    .SetReturnProperties(returnProperties bool)
    .SetIncludedProperties(includedProperties []string)


result, err := request.Send() // result is of the type []bindings.User

Copy

GET /{databaseId}/users/list/?filter=<string>
&count=<integer>
&offset=<integer>
&returnProperties=<boolean>
&includedProperties=<array>

Calls Limit Per Minute

100

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

filter

string

Located in: query

Required: No

Boolean-returning ReQL expression, which allows you to filter users to be listed. Only the users for which the expression is true will be returned.

count

integer

Located in: query

Required: No

The number of users to be listed.

offset

integer

Located in: query

Required: No

Specifies the number of users to skip (ordered by userId).

returnProperties

boolean

Located in: query

Required: No

Since version: 1.4.0

With returnProperties=true, property values of the listed users are returned along with their IDs in a JSON dictionary.

Example response:

  [
    {
      "userId": "user-81",
      "country": "US",
      "sex": "M"
    },
    {
      "userId": "user-314",
      "country": "CAN",
      "sex": "F"
    }
  ]

includedProperties

array

Located in: query

Required: No

Since version: 1.4.0

Allows specifying which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list.

Example response for includedProperties=country:

  [
    {
      "userId": "user-81",
      "country": "US"
    },
    {
      "userId": "user-314",
      "country": "CAN"
    }
  ]

Responses

200

Successful operation.

[
  "user-1",
  "user-2",
  "user-3"
]

404

Invalid URL.

User Properties

User properties definition

User properties are used for modeling users. The following methods allow the definition of user properties. The properties may be thought of as columns in a relational database table.

put

Add User Property

Adding a user property is somewhat equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddUserProperty(propertyName, type));

Copy

Initialization

client.send(AddUserProperty(property_name, type))

Copy

Initialization

client.send(AddUserProperty.new(propertyName, type))

Copy

Initialization

client.send(new AddUserProperty(String propertyName, String type));

Copy

Initialization

<?php
$client->send(new AddUserProperty($property_name, $type));
?>

Copy

Initialization

client.Send(AddUserProperty(string propertyName, string type));

Copy

Initialization

request := client.NewAddUserProperty(propertyName string, type string)

_, err := request.Send()

Copy

PUT /{databaseId}/users/properties/{propertyName}?type=<string>

Since version

1.3.0

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 1.3.0

ID of your database.

propertyName

string

Located in: path

Required: Yes

Since version: 1.3.0

Name of the user property to be created. Currently, the following names are reserved: id, userid, case-insensitively. Also, the length of the property name must not exceed 63 characters.

type

string

Located in: query

Required: Yes

Since version: 1.3.0

Value type of the user property to be created. One of: int, double, string, boolean, timestamp, set.

int - Signed integer number.
double - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
string - UTF-8 string.
boolean - true / false
timestamp - Value representing date and time.
set - Set of strings.

Responses

201

Successful operation.

400

Property name does not match ^[a-zA-Z0-9_-:]+$, or it is a reserved keyword (''id'', ''userid''), or its length exceeds 63 characters. Type information is missing, or the given type is invalid.

409

Property of the given name is already present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete User Property

Deleting a user property is roughly equivalent to removing a column from the table of users.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteUserProperty(propertyName));

Copy

Initialization

client.send(DeleteUserProperty(property_name))

Copy

Initialization

client.send(DeleteUserProperty.new(propertyName))

Copy

Initialization

client.send(new DeleteUserProperty(String propertyName));

Copy

Initialization

<?php
$client->send(new DeleteUserProperty($property_name));
?>

Copy

Initialization

client.Send(DeleteUserProperty(string propertyName));

Copy

Initialization

request := client.NewDeleteUserProperty(propertyName string)

_, err := request.Send()

Copy

DELETE /{databaseId}/users/properties/{propertyName}

Since version

1.3.0

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 1.3.0

ID of your database.

propertyName

string

Located in: path

Required: Yes

Since version: 1.3.0

Name of the property to be deleted.

Responses

200

Successful operation.

400

Property name does not match ^[a-zA-Z0-9_-:]+$.

404

Property of the given name is not present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been deleted from the database since the user property was already not present. If there is no additional info in the JSON response, you probably have an error in your URL.

get

Get User Property Info

Gets information about specified user property.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.GetUserPropertyInfo(propertyName))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(GetUserPropertyInfo(property_name))

Copy

Initialization

result = client.send(GetUserPropertyInfo.new(propertyName))

Copy

Initialization

PropertyInfo result = client.send(new GetUserPropertyInfo(String propertyName));

Copy

Initialization

<?php
$result = $client->send(new GetUserPropertyInfo($property_name));
?>

Copy

Initialization

PropertyInfo result = client.Send(GetUserPropertyInfo(string propertyName));

Copy

Initialization

request := client.NewGetUserPropertyInfo(propertyName string)

result, err := request.Send() // result is of the type bindings.PropertyInfo

Copy

GET /{databaseId}/users/properties/{propertyName}

Since version

1.3.0

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 1.3.0

ID of your database.

propertyName

string

Located in: path

Required: Yes

Since version: 1.3.0

Name of the property about which the information is to be retrieved.

Responses

200

Successful operation.

{
  "name": "country",
  "type": "string"
}

400

Property name does not match ^[a-zA-Z0-9_-:]+$.

404

Property of the given name is not present in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List User Properties

Gets the list of all the user properties in your database.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListUserProperties())
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListUserProperties())

Copy

Initialization

result = client.send(ListUserProperties.new())

Copy

Initialization

PropertyInfo[] result = client.send(new ListUserProperties());

Copy

Initialization

<?php
$result = $client->send(new ListUserProperties());
?>

Copy

Initialization

IEnumerable<PropertyInfo> result = client.Send(ListUserProperties());

Copy

Initialization

request := client.NewListUserProperties()

result, err := request.Send() // result is of the type []bindings.PropertyInfo

Copy

GET /{databaseId}/users/properties/list/

Since version

1.3.0

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 1.3.0

ID of your database.

Responses

200

Successful operation.

[
  {
    "name": "country",
    "type": "string"
  },
  {
    "name": "sex",
    "type": "string"
  }
]

404

Invalid URL.

Values of user properties

The following methods allow assigning property values to the user. Set values are examined by content-based algorithms and used in building recommendations, especially for users that have only a few interactions (e.g., new users). Useful properties may be, for example, gender or region. The values can be used in filtering using the context_user ReQL function.

post

Set User Values

Sets/updates (some) property values of the given user. The properties (columns) must be previously created by Add user property.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.SetUserValues(userId, values, {
  // optional parameters:
  'cascadeCreate': <boolean>
}));

Copy

Initialization

client.send(SetUserValues(user_id, values,
    # optional parameters:
    cascade_create=<boolean>
  )
)

Copy

Initialization

client.send(SetUserValues.new(userId, values, {
    # optional parameters:
    :cascade_create => <boolean>
  })
)

Copy

Initialization

client.send(new SetUserValues(String userId, Map<String, Object> values)
  .setCascadeCreate(boolean cascadeCreate)
);

Copy

Initialization

<?php
$client->send(new SetUserValues($user_id, $values, [
    // optional parameters:
    'cascadeCreate' => <boolean>
  ])
);
?>

Copy

Initialization

client.Send(SetUserValues(string userId, Dictionary<string, object> values,
    // optional parameters:
    cascadeCreate: <bool>
  )
);

Copy

Initialization

request := client.NewSetUserValues(userId string, values map[string]interface{})    
    // optional parameters:
    .SetCascadeCreate(cascadeCreate bool)


_, err := request.Send()

Copy

POST /{databaseId}/users/{userId}

Since version

1.3.0

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 1.3.0

ID of your database.

userId

string

Located in: path

Required: Yes

Since version: 1.3.0

ID of the user which will be modified.

object

Located in: body

Required: Yes

Since version: 1.3.0

The values for the individual properties.

Example of the body:

  {
    "country": "US",
    "sex": "F"
  }

Set user values can also cascade create the user if it's not already present in the database.

For this functionality:

When using the client libraries: Set the optional cascadeCreate parameter to true, just like when creating an interaction.
When using directly REST API: Set special "property" !cascadeCreate.

Example:
```
  {
    "country": "US",
    "!cascadeCreate": true
  }
```
Note the exclamation mark (!) at the beginning of the parameter's name to distinguish it from item property names.

Responses

200

Successful operation.

400

Property name does not match ''^[a-zA-Z0-9_-:]+$'', value does not agree to property type.

404

Property of the given name is not present in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

Get User Values

Gets all the current property values of the given user.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.GetUserValues(userId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(GetUserValues(user_id))

Copy

Initialization

result = client.send(GetUserValues.new(userId))

Copy

Initialization

Map<String, Object> result = client.send(new GetUserValues(String userId));

Copy

Initialization

<?php
$result = $client->send(new GetUserValues($user_id));
?>

Copy

Initialization

StringBinding result = client.Send(GetUserValues(string userId));

Copy

Initialization

request := client.NewGetUserValues(userId string)

result, err := request.Send() // result is of the type map[string]interface{}

Copy

GET /{databaseId}/users/{userId}

Since version

1.3.0

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 1.3.0

ID of your database.

userId

string

Located in: path

Required: Yes

Since version: 1.3.0

ID of the user whose properties are to be obtained.

Responses

200

Successful operation.

{
  "country": "US",
  "sex": "F"
}

400

The userId does not match ^[a-zA-Z0-9_-:@.]+$

404

User of the given userId is not present in the catalog. If there is no additional info in the JSON response, you probably have an error in your URL.

User-Item Interactions

The following methods allow adding, deleting, and listing interactions between the users and the items.

Detail Views

post

Add Detail View

Allowed on Client-Side

Adds a detail view of the given item made by the given user.

Javascript Kotlin Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

client.send(new recombee.AddDetailView(userId, itemId, {
  // optional parameters:
  'timestamp': <string / number>,
  'duration': <integer>,
  'cascadeCreate': <boolean>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddDetailView(userId: String, itemId: String,
    // optional parameters:
    timestamp: Instant,
    duration: Long,
    cascadeCreate: Boolean,
    recommId: String
  )
)

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddDetailView(userId, itemId, {
  // optional parameters:
  'timestamp': <string / number>,
  'duration': <integer>,
  'cascadeCreate': <boolean>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddDetailView(user_id, item_id,
    # optional parameters:
    timestamp=<string / number>,
    duration=<integer>,
    cascade_create=<boolean>,
    recomm_id=<string>
  )
)

Copy

Initialization

client.send(AddDetailView.new(userId, itemId, {
    # optional parameters:
    :timestamp => <string / number>,
    :duration => <integer>,
    :cascade_create => <boolean>,
    :recomm_id => <string>
  })
)

Copy

Initialization

client.send(new AddDetailView(String userId, String itemId)
  .setTimestamp(Date timestamp)
  .setDuration(long duration)
  .setCascadeCreate(boolean cascadeCreate)
  .setRecommId(String recommId)
);

Copy

Initialization

<?php
$client->send(new AddDetailView($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <string / number>,
    'duration' => <integer>,
    'cascadeCreate' => <boolean>,
    'recommId' => <string>
  ])
);
?>

Copy

Initialization

client.Send(AddDetailView(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>,
    duration: <long>,
    cascadeCreate: <bool>,
    recommId: <string>
  )
);

Copy

Initialization

request := client.NewAddDetailView(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)
    .SetDuration(duration int)
    .SetCascadeCreate(cascadeCreate bool)
    .SetRecommId(recommId string)


_, err := request.Send()

Copy

POST /{databaseId}/detailviews/
Body (application/json):
{
  "userId" => <string>,
  "itemId" => <string>,
  "timestamp" => <string / number>,
  "duration" => <integer>,
  "cascadeCreate" => <boolean>,
  "recommId" => <string>
}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: body

Required: Yes

User who viewed the item

itemId

string

Located in: body

Required: Yes

Viewed item

timestamp

string

number

Located in: body

Required: No

UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

duration

integer

Located in: body

Required: No

Duration of the view

cascadeCreate

boolean

Located in: body

Required: No

Sets whether the given user/item should be created if not present in the database.

recommId

string

Located in: body

Required: No

Since version: 2.2.0

If this detail view is based on a recommendation request, recommId is the id of the clicked recommendation.

Responses

200

Successful operation.

400

Given userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$. timestamp or duration is not a real number ≥ 0.

404

The cascadeCreate is not set true and the userId or the itemId were found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

409

A detail view of the exact same userId, itemId, and timestamp is already present in the database. Note that a user may view an item's details multiple times, yet triplets (userId, itemId, timestamp) must be unique. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete Detail View

Deletes an existing detail view uniquely specified by (userId, itemId, and timestamp) or all the detail views with the given userId and itemId if timestamp is omitted.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteDetailView(userId, itemId, {
  // optional parameters:
  'timestamp': <number>
}));

Copy

Initialization

client.send(DeleteDetailView(user_id, item_id,
    # optional parameters:
    timestamp=<number>
  )
)

Copy

Initialization

client.send(DeleteDetailView.new(userId, itemId, {
    # optional parameters:
    :timestamp => <number>
  })
)

Copy

Initialization

client.send(new DeleteDetailView(String userId, String itemId)
  .setTimestamp(Date timestamp)
);

Copy

Initialization

<?php
$client->send(new DeleteDetailView($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <number>
  ])
);
?>

Copy

Initialization

client.Send(DeleteDetailView(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>
  )
);

Copy

Initialization

request := client.NewDeleteDetailView(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)


_, err := request.Send()

Copy

DELETE /{databaseId}/detailviews/?userId=<string>
&itemId=<string>
&timestamp=<number>

Calls Limit Per Minute

1000

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: query

Required: Yes

ID of the user who made the detail view.

itemId

string

Located in: query

Required: Yes

ID of the item whose details were viewed.

timestamp

number

Located in: query

Required: No

Unix timestamp of the detail view. If the timestamp is omitted, then all the detail views with the given userId and itemId are deleted.

Responses

200

Successful operation.

400

Given userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$, or timestamp is not a real number ≥ 0.

404

The userId, itemId, or detail view with the given (userId, itemId, timestamp) not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Item Detail Views

Lists all the detail views of the given item ever made by different users.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListItemDetailViews(itemId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListItemDetailViews(item_id))

Copy

Initialization

result = client.send(ListItemDetailViews.new(itemId))

Copy

Initialization

DetailView[] result = client.send(new ListItemDetailViews(String itemId));

Copy

Initialization

<?php
$result = $client->send(new ListItemDetailViews($item_id));
?>

Copy

Initialization

IEnumerable<DetailView> result = client.Send(ListItemDetailViews(string itemId));

Copy

Initialization

request := client.NewListItemDetailViews(itemId string)

result, err := request.Send() // result is of the type []bindings.DetailView

Copy

GET /{databaseId}/items/{itemId}/detailviews/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item whose detail views are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "userId": "user-a",
    "duration": 14.23,
    "timestamp": 1348151906.0
  },
  {
    "itemId": "item-x",
    "userId": "user-b",
    "duration": null,
    "timestamp": 1348239363.0
  }
]

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given itemId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List User Detail Views

Lists all the detail views of different items ever made by the given user.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListUserDetailViews(userId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListUserDetailViews(user_id))

Copy

Initialization

result = client.send(ListUserDetailViews.new(userId))

Copy

Initialization

DetailView[] result = client.send(new ListUserDetailViews(String userId));

Copy

Initialization

<?php
$result = $client->send(new ListUserDetailViews($user_id));
?>

Copy

Initialization

IEnumerable<DetailView> result = client.Send(ListUserDetailViews(string userId));

Copy

Initialization

request := client.NewListUserDetailViews(userId string)

result, err := request.Send() // result is of the type []bindings.DetailView

Copy

GET /{databaseId}/users/{userId}/detailviews/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: path

Required: Yes

ID of the user whose detail views are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-y",
    "userId": "user-a",
    "duration": 134.03,
    "timestamp": 1348139180.0
  },
  {
    "itemId": "item-x",
    "userId": "user-a",
    "duration": 14.23,
    "timestamp": 1348151906.0
  }
]

400

The userId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given userId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

Purchases

post

Add Purchase

Allowed on Client-Side

Adds a purchase of the given item made by the given user.

Javascript Kotlin Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

client.send(new recombee.AddPurchase(userId, itemId, {
  // optional parameters:
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'amount': <number>,
  'price': <number>,
  'profit': <number>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddPurchase(userId: String, itemId: String,
    // optional parameters:
    timestamp: Instant,
    cascadeCreate: Boolean,
    amount: Double,
    price: Double,
    profit: Double,
    recommId: String
  )
)

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddPurchase(userId, itemId, {
  // optional parameters:
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'amount': <number>,
  'price': <number>,
  'profit': <number>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddPurchase(user_id, item_id,
    # optional parameters:
    timestamp=<string / number>,
    cascade_create=<boolean>,
    amount=<number>,
    price=<number>,
    profit=<number>,
    recomm_id=<string>
  )
)

Copy

Initialization

client.send(AddPurchase.new(userId, itemId, {
    # optional parameters:
    :timestamp => <string / number>,
    :cascade_create => <boolean>,
    :amount => <number>,
    :price => <number>,
    :profit => <number>,
    :recomm_id => <string>
  })
)

Copy

Initialization

client.send(new AddPurchase(String userId, String itemId)
  .setTimestamp(Date timestamp)
  .setCascadeCreate(boolean cascadeCreate)
  .setAmount(double amount)
  .setPrice(double price)
  .setProfit(double profit)
  .setRecommId(String recommId)
);

Copy

Initialization

<?php
$client->send(new AddPurchase($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <string / number>,
    'cascadeCreate' => <boolean>,
    'amount' => <number>,
    'price' => <number>,
    'profit' => <number>,
    'recommId' => <string>
  ])
);
?>

Copy

Initialization

client.Send(AddPurchase(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>,
    cascadeCreate: <bool>,
    amount: <double>,
    price: <double>,
    profit: <double>,
    recommId: <string>
  )
);

Copy

Initialization

request := client.NewAddPurchase(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)
    .SetCascadeCreate(cascadeCreate bool)
    .SetAmount(amount float64)
    .SetPrice(price float64)
    .SetProfit(profit float64)
    .SetRecommId(recommId string)


_, err := request.Send()

Copy

POST /{databaseId}/purchases/
Body (application/json):
{
  "userId" => <string>,
  "itemId" => <string>,
  "timestamp" => <string / number>,
  "cascadeCreate" => <boolean>,
  "amount" => <number>,
  "price" => <number>,
  "profit" => <number>,
  "recommId" => <string>
}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: body

Required: Yes

User who purchased the item

itemId

string

Located in: body

Required: Yes

Purchased item

timestamp

string

number

Located in: body

Required: No

UTC timestamp of the purchase as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

cascadeCreate

boolean

Located in: body

Required: No

Sets whether the given user/item should be created if not present in the database.

amount

number

Located in: body

Required: No

Since version: 1.6.0

Amount (number) of purchased items. The default is 1. For example, if user-x purchases two item-y during a single order (session...), the amount should equal 2.

price

number

Located in: body

Required: No

Since version: 1.6.0

Price paid by the user for the item. If amount is greater than 1, the sum of prices of all the items should be given.

profit

number

Located in: body

Required: No

Since version: 1.6.0

Your profit from the purchased item. The profit is natural in the e-commerce domain (for example, if user-x purchases item-y for $100 and the gross margin is 30 %, then the profit is $30) but is also applicable in other domains (for example, at a news company it may be income from a displayed advertisement on article page). If amount is greater than 1, the sum of profit of all the items should be given.

recommId

string

Located in: body

Required: No

Since version: 2.2.0

If this purchase is based on a recommendation request, recommId is the id of the clicked recommendation.

Responses

200

Successful operation.

400

The userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$. timestamp is not a real number ≥ 0.

404

The cascadeCreate is not set true and the userId or the itemId were found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

409

A purchase of the exact same userId, itemId, and timestamp is already present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete Purchase

Deletes an existing purchase uniquely specified by userId, itemId, and timestamp or all the purchases with the given userId and itemId if timestamp is omitted.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeletePurchase(userId, itemId, {
  // optional parameters:
  'timestamp': <number>
}));

Copy

Initialization

client.send(DeletePurchase(user_id, item_id,
    # optional parameters:
    timestamp=<number>
  )
)

Copy

Initialization

client.send(DeletePurchase.new(userId, itemId, {
    # optional parameters:
    :timestamp => <number>
  })
)

Copy

Initialization

client.send(new DeletePurchase(String userId, String itemId)
  .setTimestamp(Date timestamp)
);

Copy

Initialization

<?php
$client->send(new DeletePurchase($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <number>
  ])
);
?>

Copy

Initialization

client.Send(DeletePurchase(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>
  )
);

Copy

Initialization

request := client.NewDeletePurchase(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)


_, err := request.Send()

Copy

DELETE /{databaseId}/purchases/?userId=<string>
&itemId=<string>
&timestamp=<number>

Calls Limit Per Minute

1000

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: query

Required: Yes

ID of the user who made the purchase.

itemId

string

Located in: query

Required: Yes

ID of the item which was purchased.

timestamp

number

Located in: query

Required: No

Unix timestamp of the purchase. If the timestamp is omitted, then all the purchases with the given userId and itemId are deleted.

Responses

200

Successful operation.

400

Given userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$, or timestamp is not a real number ≥ 0.

404

The userId, itemId, or purchase with the given (userId, itemId, timestamp) not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Item Purchases

Lists all the ever-made purchases of the given item.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListItemPurchases(itemId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListItemPurchases(item_id))

Copy

Initialization

result = client.send(ListItemPurchases.new(itemId))

Copy

Initialization

Purchase[] result = client.send(new ListItemPurchases(String itemId));

Copy

Initialization

<?php
$result = $client->send(new ListItemPurchases($item_id));
?>

Copy

Initialization

IEnumerable<Purchase> result = client.Send(ListItemPurchases(string itemId));

Copy

Initialization

request := client.NewListItemPurchases(itemId string)

result, err := request.Send() // result is of the type []bindings.Purchase

Copy

GET /{databaseId}/items/{itemId}/purchases/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item whose purchases are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "userId": "user-a",
    "timestamp": 1348151906.0
  },
  {
    "itemId": "item-x",
    "userId": "user-b",
    "timestamp": 1348327154.0
  }
]

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given itemId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List User Purchases

Lists all the purchases ever made by the given user.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListUserPurchases(userId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListUserPurchases(user_id))

Copy

Initialization

result = client.send(ListUserPurchases.new(userId))

Copy

Initialization

Purchase[] result = client.send(new ListUserPurchases(String userId));

Copy

Initialization

<?php
$result = $client->send(new ListUserPurchases($user_id));
?>

Copy

Initialization

IEnumerable<Purchase> result = client.Send(ListUserPurchases(string userId));

Copy

Initialization

request := client.NewListUserPurchases(userId string)

result, err := request.Send() // result is of the type []bindings.Purchase

Copy

GET /{databaseId}/users/{userId}/purchases/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: path

Required: Yes

ID of the user whose purchases are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "timestamp": 1348151906.0,
    "userId": "user-a"
  },
  {
    "itemId": "item-z",
    "timestamp": 1348239363.0,
    "userId": "user-a"
  }
]

400

The userId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given userId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

Ratings

post

Add Rating

Allowed on Client-Side

Adds a rating of the given item made by the given user.

Javascript Kotlin Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

client.send(new recombee.AddRating(userId, itemId, rating, {
  // optional parameters:
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddRating(userId: String, itemId: String, rating: Double,
    // optional parameters:
    timestamp: Instant,
    cascadeCreate: Boolean,
    recommId: String
  )
)

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddRating(userId, itemId, rating, {
  // optional parameters:
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddRating(user_id, item_id, rating,
    # optional parameters:
    timestamp=<string / number>,
    cascade_create=<boolean>,
    recomm_id=<string>
  )
)

Copy

Initialization

client.send(AddRating.new(userId, itemId, rating, {
    # optional parameters:
    :timestamp => <string / number>,
    :cascade_create => <boolean>,
    :recomm_id => <string>
  })
)

Copy

Initialization

client.send(new AddRating(String userId, String itemId, double rating)
  .setTimestamp(Date timestamp)
  .setCascadeCreate(boolean cascadeCreate)
  .setRecommId(String recommId)
);

Copy

Initialization

<?php
$client->send(new AddRating($user_id, $item_id, $rating, [
    // optional parameters:
    'timestamp' => <string / number>,
    'cascadeCreate' => <boolean>,
    'recommId' => <string>
  ])
);
?>

Copy

Initialization

client.Send(AddRating(string userId, string itemId, double rating,
    // optional parameters:
    timestamp: <DateTime>,
    cascadeCreate: <bool>,
    recommId: <string>
  )
);

Copy

Initialization

request := client.NewAddRating(userId string, itemId string, rating float64)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)
    .SetCascadeCreate(cascadeCreate bool)
    .SetRecommId(recommId string)


_, err := request.Send()

Copy

POST /{databaseId}/ratings/
Body (application/json):
{
  "userId" => <string>,
  "itemId" => <string>,
  "timestamp" => <string / number>,
  "rating" => <number>,
  "cascadeCreate" => <boolean>,
  "recommId" => <string>
}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: body

Required: Yes

User who submitted the rating

itemId

string

Located in: body

Required: Yes

Rated item

timestamp

string

number

Located in: body

Required: No

UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

rating

number

Located in: body

Required: Yes

Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.

cascadeCreate

boolean

Located in: body

Required: No

Sets whether the given user/item should be created if not present in the database.

recommId

string

Located in: body

Required: No

Since version: 2.2.0

If this rating is based on a recommendation request, recommId is the id of the clicked recommendation.

Responses

200

Successful operation.

400

The userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$, or rating is not a real number from [-1.0,1.0], or timestamp is not a real number ≥ 0.

404

The cascadeCreate is not set true and the userId or the itemId were found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

409

A rating of the exact same userId, itemId, and timestamp is already present in the database. Note that a user may view an item's details multiple times, yet triplets (userId, itemId, timestamp) must be unique. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete Rating

Deletes an existing rating specified by (userId, itemId, timestamp) from the database or all the ratings with the given userId and itemId if timestamp is omitted.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteRating(userId, itemId, {
  // optional parameters:
  'timestamp': <number>
}));

Copy

Initialization

client.send(DeleteRating(user_id, item_id,
    # optional parameters:
    timestamp=<number>
  )
)

Copy

Initialization

client.send(DeleteRating.new(userId, itemId, {
    # optional parameters:
    :timestamp => <number>
  })
)

Copy

Initialization

client.send(new DeleteRating(String userId, String itemId)
  .setTimestamp(Date timestamp)
);

Copy

Initialization

<?php
$client->send(new DeleteRating($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <number>
  ])
);
?>

Copy

Initialization

client.Send(DeleteRating(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>
  )
);

Copy

Initialization

request := client.NewDeleteRating(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)


_, err := request.Send()

Copy

DELETE /{databaseId}/ratings/?userId=<string>
&itemId=<string>
&timestamp=<number>

Calls Limit Per Minute

1000

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: query

Required: Yes

ID of the user who rated the item.

itemId

string

Located in: query

Required: Yes

ID of the item which was rated.

timestamp

number

Located in: query

Required: No

Unix timestamp of the rating. If the timestamp is omitted, then all the ratings with the given userId and itemId are deleted.

Responses

200

Successful operation.

400

Given userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$, or timestamp is not a real number ≥ 0.

404

The userId, itemId or rating with the given (userId, itemId, timestamp) not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Item Ratings

Lists all the ratings of an item ever submitted by different users.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListItemRatings(itemId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListItemRatings(item_id))

Copy

Initialization

result = client.send(ListItemRatings.new(itemId))

Copy

Initialization

Rating[] result = client.send(new ListItemRatings(String itemId));

Copy

Initialization

<?php
$result = $client->send(new ListItemRatings($item_id));
?>

Copy

Initialization

IEnumerable<Rating> result = client.Send(ListItemRatings(string itemId));

Copy

Initialization

request := client.NewListItemRatings(itemId string)

result, err := request.Send() // result is of the type []bindings.Rating

Copy

GET /{databaseId}/items/{itemId}/ratings/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item whose ratings are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "userId": "user-a",
    "rating": -0.25,
    "timestamp": 1348151906.0
  },
  {
    "itemId": "item-x",
    "userId": "user-b",
    "rating": 0.0,
    "timestamp": 1348239363.0
  }
]

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given itemId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List User Ratings

Lists all the ratings ever submitted by the given user.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListUserRatings(userId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListUserRatings(user_id))

Copy

Initialization

result = client.send(ListUserRatings.new(userId))

Copy

Initialization

Rating[] result = client.send(new ListUserRatings(String userId));

Copy

Initialization

<?php
$result = $client->send(new ListUserRatings($user_id));
?>

Copy

Initialization

IEnumerable<Rating> result = client.Send(ListUserRatings(string userId));

Copy

Initialization

request := client.NewListUserRatings(userId string)

result, err := request.Send() // result is of the type []bindings.Rating

Copy

GET /{databaseId}/users/{userId}/ratings/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: path

Required: Yes

ID of the user whose ratings are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-y",
    "userId": "user-a",
    "rating": 0.5,
    "timestamp": 1348139180.0
  },
  {
    "itemId": "item-x",
    "userId": "user-a",
    "rating": -0.25,
    "timestamp": 1348151906.0
  }
]

400

The userId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given userId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

Cart Additions

post

Add Cart Addition

Allowed on Client-Side

Adds a cart addition of the given item made by the given user.

Javascript Kotlin Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

client.send(new recombee.AddCartAddition(userId, itemId, {
  // optional parameters:
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'amount': <number>,
  'price': <number>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddCartAddition(userId: String, itemId: String,
    // optional parameters:
    timestamp: Instant,
    cascadeCreate: Boolean,
    amount: Double,
    price: Double,
    recommId: String
  )
)

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddCartAddition(userId, itemId, {
  // optional parameters:
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'amount': <number>,
  'price': <number>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddCartAddition(user_id, item_id,
    # optional parameters:
    timestamp=<string / number>,
    cascade_create=<boolean>,
    amount=<number>,
    price=<number>,
    recomm_id=<string>
  )
)

Copy

Initialization

client.send(AddCartAddition.new(userId, itemId, {
    # optional parameters:
    :timestamp => <string / number>,
    :cascade_create => <boolean>,
    :amount => <number>,
    :price => <number>,
    :recomm_id => <string>
  })
)

Copy

Initialization

client.send(new AddCartAddition(String userId, String itemId)
  .setTimestamp(Date timestamp)
  .setCascadeCreate(boolean cascadeCreate)
  .setAmount(double amount)
  .setPrice(double price)
  .setRecommId(String recommId)
);

Copy

Initialization

<?php
$client->send(new AddCartAddition($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <string / number>,
    'cascadeCreate' => <boolean>,
    'amount' => <number>,
    'price' => <number>,
    'recommId' => <string>
  ])
);
?>

Copy

Initialization

client.Send(AddCartAddition(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>,
    cascadeCreate: <bool>,
    amount: <double>,
    price: <double>,
    recommId: <string>
  )
);

Copy

Initialization

request := client.NewAddCartAddition(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)
    .SetCascadeCreate(cascadeCreate bool)
    .SetAmount(amount float64)
    .SetPrice(price float64)
    .SetRecommId(recommId string)


_, err := request.Send()

Copy

POST /{databaseId}/cartadditions/
Body (application/json):
{
  "userId" => <string>,
  "itemId" => <string>,
  "timestamp" => <string / number>,
  "cascadeCreate" => <boolean>,
  "amount" => <number>,
  "price" => <number>,
  "recommId" => <string>
}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: body

Required: Yes

User who added the item to the cart

itemId

string

Located in: body

Required: Yes

Item added to the cart

timestamp

string

number

Located in: body

Required: No

UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

cascadeCreate

boolean

Located in: body

Required: No

Sets whether the given user/item should be created if not present in the database.

amount

number

Located in: body

Required: No

Since version: 1.6.0

Amount (number) added to cart. The default is 1. For example, if user-x adds two item-y during a single order (session...), the amount should equal 2.

price

number

Located in: body

Required: No

Since version: 1.6.0

Price of the added item. If amount is greater than 1, the sum of prices of all the items should be given.

recommId

string

Located in: body

Required: No

Since version: 2.2.0

If this cart addition is based on a recommendation request, recommId is the id of the clicked recommendation.

Responses

200

Successful operation.

400

The userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$, timestamp is not a real number ≥ 0.

404

The cascadeCreate is not set true and the userId or the itemId were found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

409

A cart addition of the exact same userId, itemId, and timestamp is already present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete Cart Addition

Deletes an existing cart addition uniquely specified by userId, itemId, and timestamp or all the cart additions with the given userId and itemId if timestamp is omitted.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteCartAddition(userId, itemId, {
  // optional parameters:
  'timestamp': <number>
}));

Copy

Initialization

client.send(DeleteCartAddition(user_id, item_id,
    # optional parameters:
    timestamp=<number>
  )
)

Copy

Initialization

client.send(DeleteCartAddition.new(userId, itemId, {
    # optional parameters:
    :timestamp => <number>
  })
)

Copy

Initialization

client.send(new DeleteCartAddition(String userId, String itemId)
  .setTimestamp(Date timestamp)
);

Copy

Initialization

<?php
$client->send(new DeleteCartAddition($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <number>
  ])
);
?>

Copy

Initialization

client.Send(DeleteCartAddition(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>
  )
);

Copy

Initialization

request := client.NewDeleteCartAddition(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)


_, err := request.Send()

Copy

DELETE /{databaseId}/cartadditions/?userId=<string>
&itemId=<string>
&timestamp=<number>

Calls Limit Per Minute

1000

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: query

Required: Yes

ID of the user who made the cart addition.

itemId

string

Located in: query

Required: Yes

ID of the item which was added to the cart.

timestamp

number

Located in: query

Required: No

Unix timestamp of the cart addition. If the timestamp is omitted, then all the cart additions with the given userId and itemId are deleted.

Responses

200

Successful operation.

400

Given userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$, or timestamp is not a real number ≥ 0.

404

The userId, itemId, or cart addition with the given (userId, itemId, timestamp) not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Item Cart Additions

Lists all the ever-made cart additions of the given item.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListItemCartAdditions(itemId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListItemCartAdditions(item_id))

Copy

Initialization

result = client.send(ListItemCartAdditions.new(itemId))

Copy

Initialization

CartAddition[] result = client.send(new ListItemCartAdditions(String itemId));

Copy

Initialization

<?php
$result = $client->send(new ListItemCartAdditions($item_id));
?>

Copy

Initialization

IEnumerable<CartAddition> result = client.Send(ListItemCartAdditions(string itemId));

Copy

Initialization

request := client.NewListItemCartAdditions(itemId string)

result, err := request.Send() // result is of the type []bindings.CartAddition

Copy

GET /{databaseId}/items/{itemId}/cartadditions/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item whose cart additions are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "userId": "user-a",
    "timestamp": 1348151906.0
  },
  {
    "itemId": "item-x",
    "userId": "user-a",
    "timestamp": 1348327154.0
  }
]

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given itemId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List User Cart Additions

Lists all the cart additions ever made by the given user.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListUserCartAdditions(userId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListUserCartAdditions(user_id))

Copy

Initialization

result = client.send(ListUserCartAdditions.new(userId))

Copy

Initialization

CartAddition[] result = client.send(new ListUserCartAdditions(String userId));

Copy

Initialization

<?php
$result = $client->send(new ListUserCartAdditions($user_id));
?>

Copy

Initialization

IEnumerable<CartAddition> result = client.Send(ListUserCartAdditions(string userId));

Copy

Initialization

request := client.NewListUserCartAdditions(userId string)

result, err := request.Send() // result is of the type []bindings.CartAddition

Copy

GET /{databaseId}/users/{userId}/cartadditions/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: path

Required: Yes

ID of the user whose cart additions are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "timestamp": 1348151906.0,
    "userId": "user-a"
  },
  {
    "itemId": "item-z",
    "timestamp": 1348239363.0,
    "userId": "user-a"
  }
]

400

The userId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given userId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

Bookmarks

post

Add Bookmark

Allowed on Client-Side

Adds a bookmark of the given item made by the given user.

Javascript Kotlin Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

client.send(new recombee.AddBookmark(userId, itemId, {
  // optional parameters:
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddBookmark(userId: String, itemId: String,
    // optional parameters:
    timestamp: Instant,
    cascadeCreate: Boolean,
    recommId: String
  )
)

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.AddBookmark(userId, itemId, {
  // optional parameters:
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'recommId': <string>
}));

Copy

Initialization

client.send(AddBookmark(user_id, item_id,
    # optional parameters:
    timestamp=<string / number>,
    cascade_create=<boolean>,
    recomm_id=<string>
  )
)

Copy

Initialization

client.send(AddBookmark.new(userId, itemId, {
    # optional parameters:
    :timestamp => <string / number>,
    :cascade_create => <boolean>,
    :recomm_id => <string>
  })
)

Copy

Initialization

client.send(new AddBookmark(String userId, String itemId)
  .setTimestamp(Date timestamp)
  .setCascadeCreate(boolean cascadeCreate)
  .setRecommId(String recommId)
);

Copy

Initialization

<?php
$client->send(new AddBookmark($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <string / number>,
    'cascadeCreate' => <boolean>,
    'recommId' => <string>
  ])
);
?>

Copy

Initialization

client.Send(AddBookmark(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>,
    cascadeCreate: <bool>,
    recommId: <string>
  )
);

Copy

Initialization

request := client.NewAddBookmark(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)
    .SetCascadeCreate(cascadeCreate bool)
    .SetRecommId(recommId string)


_, err := request.Send()

Copy

POST /{databaseId}/bookmarks/
Body (application/json):
{
  "userId" => <string>,
  "itemId" => <string>,
  "timestamp" => <string / number>,
  "cascadeCreate" => <boolean>,
  "recommId" => <string>
}

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: body

Required: Yes

User who bookmarked the item

itemId

string

Located in: body

Required: Yes

Bookmarked item

timestamp

string

number

Located in: body

Required: No

UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

cascadeCreate

boolean

Located in: body

Required: No

Sets whether the given user/item should be created if not present in the database.

recommId

string

Located in: body

Required: No

Since version: 2.2.0

If this bookmark is based on a recommendation request, recommId is the id of the clicked recommendation.

Responses

200

Successful operation.

400

The userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$, timestamp is not a real number ≥ 0.

404

The cascadeCreate is not set true and the userId or the itemId were found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

409

A bookmark of the exact same userId, itemId, and timestamp is already present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete Bookmark

Deletes a bookmark uniquely specified by userId, itemId, and timestamp or all the bookmarks with the given userId and itemId if timestamp is omitted.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteBookmark(userId, itemId, {
  // optional parameters:
  'timestamp': <number>
}));

Copy

Initialization

client.send(DeleteBookmark(user_id, item_id,
    # optional parameters:
    timestamp=<number>
  )
)

Copy

Initialization

client.send(DeleteBookmark.new(userId, itemId, {
    # optional parameters:
    :timestamp => <number>
  })
)

Copy

Initialization

client.send(new DeleteBookmark(String userId, String itemId)
  .setTimestamp(Date timestamp)
);

Copy

Initialization

<?php
$client->send(new DeleteBookmark($user_id, $item_id, [
    // optional parameters:
    'timestamp' => <number>
  ])
);
?>

Copy

Initialization

client.Send(DeleteBookmark(string userId, string itemId,
    // optional parameters:
    timestamp: <DateTime>
  )
);

Copy

Initialization

request := client.NewDeleteBookmark(userId string, itemId string)    
    // optional parameters:
    .SetTimestamp(timestamp time.Time)


_, err := request.Send()

Copy

DELETE /{databaseId}/bookmarks/?userId=<string>
&itemId=<string>
&timestamp=<number>

Calls Limit Per Minute

1000

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: query

Required: Yes

ID of the user who made the bookmark.

itemId

string

Located in: query

Required: Yes

ID of the item which was bookmarked.

timestamp

number

Located in: query

Required: No

Unix timestamp of the bookmark. If the timestamp is omitted, then all the bookmarks with the given userId and itemId are deleted.

Responses

200

Successful operation.

400

Given userId or itemId does not match ^[a-zA-Z0-9_-:@.]+$, or timestamp is not a real number ≥ 0.

404

The userId, itemId, or bookmark with the given (userId, itemId, timestamp) not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Item Bookmarks

Lists all the ever-made bookmarks of the given item.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListItemBookmarks(itemId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListItemBookmarks(item_id))

Copy

Initialization

result = client.send(ListItemBookmarks.new(itemId))

Copy

Initialization

Bookmark[] result = client.send(new ListItemBookmarks(String itemId));

Copy

Initialization

<?php
$result = $client->send(new ListItemBookmarks($item_id));
?>

Copy

Initialization

IEnumerable<Bookmark> result = client.Send(ListItemBookmarks(string itemId));

Copy

Initialization

request := client.NewListItemBookmarks(itemId string)

result, err := request.Send() // result is of the type []bindings.Bookmark

Copy

GET /{databaseId}/items/{itemId}/bookmarks/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

itemId

string

Located in: path

Required: Yes

ID of the item whose bookmarks are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "userId": "user-a",
    "timestamp": 1348151906.0
  },
  {
    "itemId": "item-x",
    "userId": "user-a",
    "timestamp": 1348327154.0
  }
]

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given itemId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List User Bookmarks

Lists all the bookmarks ever made by the given user.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListUserBookmarks(userId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListUserBookmarks(user_id))

Copy

Initialization

result = client.send(ListUserBookmarks.new(userId))

Copy

Initialization

Bookmark[] result = client.send(new ListUserBookmarks(String userId));

Copy

Initialization

<?php
$result = $client->send(new ListUserBookmarks($user_id));
?>

Copy

Initialization

IEnumerable<Bookmark> result = client.Send(ListUserBookmarks(string userId));

Copy

Initialization

request := client.NewListUserBookmarks(userId string)

result, err := request.Send() // result is of the type []bindings.Bookmark

Copy

GET /{databaseId}/users/{userId}/bookmarks/

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

ID of your database.

userId

string

Located in: path

Required: Yes

ID of the user whose bookmarks are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "timestamp": 1348151906.0,
    "userId": "user-a"
  },
  {
    "itemId": "item-z",
    "timestamp": 1348239363.0,
    "userId": "user-a"
  }
]

400

The userId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given userId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

View Portions

post

Set View Portion

Allowed on Client-Side

Sets viewed portion of an item (for example a video or article) by a user (at a session). If you send a new request with the same (userId, itemId, sessionId), the portion gets updated.

Javascript Kotlin Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

client.send(new recombee.SetViewPortion(userId, itemId, portion, {
  // optional parameters:
  'sessionId': <string>,
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'recommId': <string>,
  'additionalData': <Object>
}));

Copy

Initialization

client.send(SetViewPortion(userId: String, itemId: String, portion: Double,
    // optional parameters:
    sessionId: String,
    timestamp: Instant,
    cascadeCreate: Boolean,
    recommId: String,
    additionalData: Map<String, Any>
  )
)

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.SetViewPortion(userId, itemId, portion, {
  // optional parameters:
  'sessionId': <string>,
  'timestamp': <string / number>,
  'cascadeCreate': <boolean>,
  'recommId': <string>,
  'additionalData': <Object>
}));

Copy

Initialization

client.send(SetViewPortion(user_id, item_id, portion,
    # optional parameters:
    session_id=<string>,
    timestamp=<string / number>,
    cascade_create=<boolean>,
    recomm_id=<string>,
    additional_data=<dict>
  )
)

Copy

Initialization

client.send(SetViewPortion.new(userId, itemId, portion, {
    # optional parameters:
    :session_id => <string>,
    :timestamp => <string / number>,
    :cascade_create => <boolean>,
    :recomm_id => <string>,
    :additional_data => <Hash>
  })
)

Copy

Initialization

client.send(new SetViewPortion(String userId, String itemId, double portion)
  .setSessionId(String sessionId)
  .setTimestamp(Date timestamp)
  .setCascadeCreate(boolean cascadeCreate)
  .setRecommId(String recommId)
  .setAdditionalData(Map<String, Object> additionalData)
);

Copy

Initialization

<?php
$client->send(new SetViewPortion($user_id, $item_id, $portion, [
    // optional parameters:
    'sessionId' => <string>,
    'timestamp' => <string / number>,
    'cascadeCreate' => <boolean>,
    'recommId' => <string>,
    'additionalData' => <array (map)>
  ])
);
?>

Copy

Initialization

client.Send(SetViewPortion(string userId, string itemId, double portion,
    // optional parameters:
    sessionId: <string>,
    timestamp: <DateTime>,
    cascadeCreate: <bool>,
    recommId: <string>,
    additionalData: <Dictionary<string, object>>
  )
);

Copy

Initialization

request := client.NewSetViewPortion(userId string, itemId string, portion float64)    
    // optional parameters:
    .SetSessionId(sessionId string)
    .SetTimestamp(timestamp time.Time)
    .SetCascadeCreate(cascadeCreate bool)
    .SetRecommId(recommId string)
    .SetAdditionalData(additionalData map[string]interface{})


_, err := request.Send()

Copy

POST /{databaseId}/viewportions/
Body (application/json):
{
  "userId" => <string>,
  "itemId" => <string>,
  "portion" => <number>,
  "sessionId" => <string>,
  "timestamp" => <string / number>,
  "cascadeCreate" => <boolean>,
  "recommId" => <string>,
  "additionalData" => <Object>
}

Since version

2.1.0

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 2.1.0

ID of your database.

userId

string

Located in: body

Required: Yes

Since version: 2.1.0

User who viewed a portion of the item

itemId

string

Located in: body

Required: Yes

Since version: 2.1.0

Viewed item

portion

number

Located in: body

Required: Yes

Since version: 2.1.0

Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the actual viewed part of the item, no matter the seeking. For example, if the user seeked immediately to half of the item and then viewed 10% of the item, the portion should still be 0.1.

sessionId

string

Located in: body

Required: No

Since version: 2.1.0

ID of the session in which the user viewed the item. Default is null (None, nil, NULL etc., depending on the language).

timestamp

string

number

Located in: body

Required: No

Since version: 2.1.0

UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

cascadeCreate

boolean

Located in: body

Required: No

Since version: 2.1.0

Sets whether the given user/item should be created if not present in the database.

recommId

string

Located in: body

Required: No

Since version: 2.2.0

If this view portion is based on a recommendation request, recommId is the id of the clicked recommendation.

additionalData

object

Located in: body

Required: No

Since version: 2.3.0

A dictionary of additional data for the interaction.

Responses

200

Successful operation.

400

The userId, itemId or sessionId does not match ^[a-zA-Z0-9_-:@.]+$, or the portion is not a real number from [0.0,1.0].

404

The cascadeCreate is not set true and the userId or the itemId were found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

409

A view portion of the exact same userId, itemId, and a greater or equal timestamp (or a greater portion) is already present in the database. In many cases, you may consider this code a success – it only tells you that nothing has been written to the database.

delete

Delete View Portion

Deletes an existing view portion specified by (userId, itemId, sessionId) from the database.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.DeleteViewPortion(userId, itemId, {
  // optional parameters:
  'sessionId': <string>
}));

Copy

Initialization

client.send(DeleteViewPortion(user_id, item_id,
    # optional parameters:
    session_id=<string>
  )
)

Copy

Initialization

client.send(DeleteViewPortion.new(userId, itemId, {
    # optional parameters:
    :session_id => <string>
  })
)

Copy

Initialization

client.send(new DeleteViewPortion(String userId, String itemId)
  .setSessionId(String sessionId)
);

Copy

Initialization

<?php
$client->send(new DeleteViewPortion($user_id, $item_id, [
    // optional parameters:
    'sessionId' => <string>
  ])
);
?>

Copy

Initialization

client.Send(DeleteViewPortion(string userId, string itemId,
    // optional parameters:
    sessionId: <string>
  )
);

Copy

Initialization

request := client.NewDeleteViewPortion(userId string, itemId string)    
    // optional parameters:
    .SetSessionId(sessionId string)


_, err := request.Send()

Copy

DELETE /{databaseId}/viewportions/?userId=<string>
&itemId=<string>
&sessionId=<string>

Since version

2.1.0

Calls Limit Per Minute

1000

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 2.1.0

ID of your database.

userId

string

Located in: query

Required: Yes

Since version: 2.1.0

ID of the user who rated the item.

itemId

string

Located in: query

Required: Yes

Since version: 2.1.0

ID of the item which was rated.

sessionId

string

Located in: query

Required: No

Since version: 2.1.0

Identifier of a session.

Responses

200

Successful operation.

400

Given userId, itemId or sessionId does not match ^[a-zA-Z0-9_-:@.]+$.

404

The userId, itemId or view portion with the given (userId, itemId, sessionId) not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List Item View Portions

Lists all the view portions of an item ever submitted by different users.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListItemViewPortions(itemId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListItemViewPortions(item_id))

Copy

Initialization

result = client.send(ListItemViewPortions.new(itemId))

Copy

Initialization

ViewPortion[] result = client.send(new ListItemViewPortions(String itemId));

Copy

Initialization

<?php
$result = $client->send(new ListItemViewPortions($item_id));
?>

Copy

Initialization

IEnumerable<ViewPortion> result = client.Send(ListItemViewPortions(string itemId));

Copy

Initialization

request := client.NewListItemViewPortions(itemId string)

result, err := request.Send() // result is of the type []bindings.ViewPortion

Copy

GET /{databaseId}/items/{itemId}/viewportions/

Since version

2.1.0

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 2.1.0

ID of your database.

itemId

string

Located in: path

Required: Yes

Since version: 2.1.0

ID of the item whose view portions are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "userId": "user-a",
    "sessionId": "ABAD1D",
    "portion": 0.5,
    "timestamp": 1348151906.0
  },
  {
    "itemId": "item-x",
    "userId": "user-b",
    "sessionId": null,
    "portion": 1,
    "timestamp": 1348239363.0
  }
]

400

The itemId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given itemId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

get

List User View Portions

Lists all the view portions ever submitted by the given user.

Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.ListUserViewPortions(userId))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(ListUserViewPortions(user_id))

Copy

Initialization

result = client.send(ListUserViewPortions.new(userId))

Copy

Initialization

ViewPortion[] result = client.send(new ListUserViewPortions(String userId));

Copy

Initialization

<?php
$result = $client->send(new ListUserViewPortions($user_id));
?>

Copy

Initialization

IEnumerable<ViewPortion> result = client.Send(ListUserViewPortions(string userId));

Copy

Initialization

request := client.NewListUserViewPortions(userId string)

result, err := request.Send() // result is of the type []bindings.ViewPortion

Copy

GET /{databaseId}/users/{userId}/viewportions/

Since version

2.1.0

Calls Limit Per Minute

Parameters

databaseId

string

Located in: path

Required: Yes

Since version: 2.1.0

ID of your database.

userId

string

Located in: path

Required: Yes

Since version: 2.1.0

ID of the user whose view portions are to be listed.

Responses

200

Successful operation.

[
  {
    "itemId": "item-x",
    "userId": "user-a",
    "sessionId": "ABAD1D",
    "portion": 0.25,
    "timestamp": 1348151906.0
  },
  {
    "itemId": "item-y",
    "userId": "user-a",
    "sessionId": "EWQKOL",
    "portion": 0.1,
    "timestamp": 1348239363.0
  }
]

400

The userId does not match ^[a-zA-Z0-9_-:@.]+$.

404

Given userId not found in the database. If there is no additional info in the JSON response, you probably have an error in your URL.

Recommendations

Recommendation methods are capable of recommending items (Recommend items to user, Recommend items to item) or users (Recommend users to item, Recommend users to user).

See Segmentations section for recommendation endpoints that return segments (e.g. recommend categories to a user).

Recommending Items

Recommendation endpoints that return the Items (content, products, etc.).

get

Allowed on Client-Side

Based on the user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for the given user.

The most typical use cases are recommendations on the homepage, in some "Picked just for you" section, or in email.

The returned items are sorted by relevance (the first item being the most relevant).

Besides the recommended items, also a unique recommId is returned in the response. It can be used to:

Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See Reported metrics.
Get subsequent recommended items when the user scrolls down (infinite scroll) or goes to the next page. See Recommend Next Items.

It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.

Javascript Kotlin Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

client.send(new recombee.RecommendItemsToUser(userId, count, {
  // optional parameters:
  'scenario': <string>,
  'cascadeCreate': <boolean>,
  'returnProperties': <boolean>,
  'includedProperties': <array>,
  'filter': <string>,
  'booster': <string>,
  'logic': <string / Object>,
  'minRelevance': <string>,
  'rotationRate': <number>,
  'rotationTime': <number>
})).then(function(res) {
  // handle response 
});

Copy

Initialization

val result = client.sendAsync(RecommendItemsToUser(userId: String, count: Long,
    // optional parameters:
    scenario: String,
    cascadeCreate: Boolean,
    returnProperties: Boolean,
    includedProperties: List<String>,
    filter: String,
    booster: String,
    logic: Logic,
    minRelevance: String,
    rotationRate: Double,
    rotationTime: Double
  )
)

result.onSuccess { response: RecommendationResponse ->
    // Handle response
}.onFailure { exception -> // ApiException
    // Handle exception
}

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.RecommendItemsToUser(userId, count, {
  // optional parameters:
  'scenario': <string>,
  'cascadeCreate': <boolean>,
  'returnProperties': <boolean>,
  'includedProperties': <array>,
  'filter': <string>,
  'booster': <string>,
  'logic': <string / Object>,
  'minRelevance': <string>,
  'rotationRate': <number>,
  'rotationTime': <number>
}))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(RecommendItemsToUser(user_id, count,
    # optional parameters:
    scenario=<string>,
    cascade_create=<boolean>,
    return_properties=<boolean>,
    included_properties=<array>,
    filter=<string>,
    booster=<string>,
    logic=<string / dict>,
    min_relevance=<string>,
    rotation_rate=<number>,
    rotation_time=<number>
  )
)

Copy

Initialization

result = client.send(RecommendItemsToUser.new(userId, count, {
    # optional parameters:
    :scenario => <string>,
    :cascade_create => <boolean>,
    :return_properties => <boolean>,
    :included_properties => <array>,
    :filter => <string>,
    :booster => <string>,
    :logic => <string / Hash>,
    :min_relevance => <string>,
    :rotation_rate => <number>,
    :rotation_time => <number>
  })
)

Copy

Initialization

RecommendationResponse result = client.send(new RecommendItemsToUser(String userId, long count)
  .setScenario(String scenario)
  .setCascadeCreate(boolean cascadeCreate)
  .setReturnProperties(boolean returnProperties)
  .setIncludedProperties(String[] includedProperties)
  .setFilter(String filter)
  .setBooster(String booster)
  .setLogic(Logic logic)
  .setMinRelevance(String minRelevance)
  .setRotationRate(double rotationRate)
  .setRotationTime(double rotationTime)
);

Copy

Initialization

<?php
$result = $client->send(new RecommendItemsToUser($user_id, $count, [
    // optional parameters:
    'scenario' => <string>,
    'cascadeCreate' => <boolean>,
    'returnProperties' => <boolean>,
    'includedProperties' => <array>,
    'filter' => <string>,
    'booster' => <string>,
    'logic' => <string / array (map)>,
    'minRelevance' => <string>,
    'rotationRate' => <number>,
    'rotationTime' => <number>
  ])
);
?>

Copy

Initialization

RecommendationResponse result = client.Send(RecommendItemsToUser(string userId, long count,
    // optional parameters:
    scenario: <string>,
    cascadeCreate: <bool>,
    returnProperties: <bool>,
    includedProperties: <string[]>,
    filter: <string>,
    booster: <string>,
    logic: <Logic>,
    minRelevance: <string>,
    rotationRate: <double>,
    rotationTime: <double>
  )
);

Copy

Initialization

request := client.NewRecommendItemsToUser(userId string, count int)    
    // optional parameters:
    .SetScenario(scenario string)
    .SetCascadeCreate(cascadeCreate bool)
    .SetReturnProperties(returnProperties bool)
    .SetIncludedProperties(includedProperties []string)
    .SetFilter(filter string)
    .SetBooster(booster string)
    .SetLogic(logic bindings.Logic)
    .SetMinRelevance(minRelevance string)
    .SetRotationRate(rotationRate float64)
    .SetRotationTime(rotationTime float64)


result, err := request.Send() // result is of the type bindings.RecommendationResponse

Copy

GET /{databaseId}/recomms/users/{userId}/items/?count=<integer>
&scenario=<string>
&cascadeCreate=<boolean>
&returnProperties=<boolean>
&includedProperties=<array>
&filter=<string>
&booster=<string>
&logic=<string / Object>
&minRelevance=<string>
&rotationRate=<number>
&rotationTime=<number>

Since version

2.0.0

returnProperties

boolean

Located in: query

Required: No

Since version: 2.0.0

With returnProperties=true, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user.

Example response:

  {
    "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
    "recomms": 
      [
        {
          "id": "tv-178",
          "values": {
            "description": "4K TV with 3D feature",
            "categories":   ["Electronics", "Televisions"],
            "price": 342,
            "url": "myshop.com/tv-178"
          }
        },
        {
          "id": "mixer-42",
          "values": {
            "description": "Stainless Steel Mixer",
            "categories":   ["Home & Kitchen"],
            "price": 39,
            "url": "myshop.com/mixer-42"
          }
        }
      ],
     "numberNextRecommsCalls": 0
  }

includedProperties

array

Located in: query

Required: No

Since version: 2.0.0

Allows specifying which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list.

Example response for includedProperties=description,price:

  {
    "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
    "recomms":
      [
        {
          "id": "tv-178",
          "values": {
            "description": "4K TV with 3D feature",
            "price": 342
          }
        },
        {
          "id": "mixer-42",
          "values": {
            "description": "Stainless Steel Mixer",
            "price": 39
          }
        }
      ],
    "numberNextRecommsCalls": 0
  }

200

Successful operation.

{
  "recommId": "3f6ad2f2-a3f1-4ba1-a690-f4f01f76d4eb",
  "recomms": [
    {
      "id": "item-146"
    },
    {
      "id": "item-462"
    },
    {
      "id": "item-463"
    }
  ],
  "numberNextRecommsCalls": 0
}

400

userId does not match ^[a-zA-Z0-9_-:@.]+$, count is not a positive integer, filter or booster is not valid ReQL expressions, filter expression does not return boolean, booster does not return double or integer.

404

userId not found in the database and cascadeCreate is false. If there is no additional info in the JSON response, you probably have an error in your URL.

get

Allowed on Client-Side

Recommends a set of items that are somehow related to one given item, X. A typical scenario is when the user A is viewing X. Then you may display items to the user that he might also be interested in. Recommend items to item request gives you Top-N such items, optionally taking the target user A into account.

The returned items are sorted by relevance (the first item being the most relevant).

Besides the recommended items, also a unique recommId is returned in the response. It can be used to:

Let Recombee know that this recommendation was successful (e.g., user clicked one of the recommended items). See Reported metrics.
Get subsequent recommended items when the user scrolls down (infinite scroll) or goes to the next page. See Recommend Next Items.

It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.

Javascript Kotlin Node.js Python Ruby Java PHP C#Go REST

Copy

Initialization

client.send(new recombee.RecommendItemsToItem(itemId, targetUserId, count, {
  // optional parameters:
  'scenario': <string>,
  'cascadeCreate': <boolean>,
  'returnProperties': <boolean>,
  'includedProperties': <array>,
  'filter': <string>,
  'booster': <string>,
  'logic': <string / Object>,
  'minRelevance': <string>,
  'rotationRate': <number>,
  'rotationTime': <number>
})).then(function(res) {
  // handle response 
});

Copy

Initialization

val result = client.sendAsync(RecommendItemsToItem(itemId: String, targetUserId: String, count: Long,
    // optional parameters:
    scenario: String,
    cascadeCreate: Boolean,
    returnProperties: Boolean,
    includedProperties: List<String>,
    filter: String,
    booster: String,
    logic: Logic,
    minRelevance: String,
    rotationRate: Double,
    rotationTime: Double
  )
)

result.onSuccess { response: RecommendationResponse ->
    // Handle response
}.onFailure { exception -> // ApiException
    // Handle exception
}

Copy

Initialization

var recombee = require('recombee-api-client');
var rqs = recombee.requests;

client.send(new rqs.RecommendItemsToItem(itemId, targetUserId, count, {
  // optional parameters:
  'scenario': <string>,
  'cascadeCreate': <boolean>,
  'returnProperties': <boolean>,
  'includedProperties': <array>,
  'filter': <string>,
  'booster': <string>,
  'logic': <string / Object>,
  'minRelevance': <string>,
  'rotationRate': <number>,
  'rotationTime': <number>
}))
.then((response) => {
    //handle response
})
.catch((error) => {
    //handle error
});

Copy

Initialization

result = client.send(RecommendItemsToItem(item_id, target_user_id, count,
    # optional parameters:
    scenario=<string>,
    cascade_create=<boolean>,
    return_properties=<boolean>,
    included_properties=<array>,
    filter=<string>,
    booster=<string>,
    logic=<string / dict>,
    min_relevance=<string>,
    rotation_rate=<number>,
    rotation_time=<number>
  )
)

Copy

Initialization

result = client.send(RecommendItemsToItem.new(itemId, targetUserId, count, {
    # optional parameters:
    :scenario => <string>,
    :cascade_create => <boolean>,
    :return_properties => <boolean>,
    :included_properties => <array>,
    :filter => <string>,
    :booster => <string>,
    :logic => <string / Hash>,
    :min_relevance => <string>,
    :rotation_rate => <number>,
    :rotation_time => <number>
  })
)

Copy

Initialization

RecommendationResponse result = client.send(new RecommendItemsToItem(String itemId, String targetUserId, long count)
  .setScenario(String scenario)
  .setCascadeCreate(boolean cascadeCreate)
  .setReturnProperties(boolean returnProperties)
  .setIncludedProperties(String[] includedProperties)
  .setFilter(String filter)
  .setBooster(String booster)
  .setLogic(Logic logic)
  .setMinRelevance(String minRelevance)
  .setRotationRate(double rotationRate)
  .setRotationTime(double rotationTime)
);

Copy

Initialization

<?php
$result = $client->send(new RecommendItemsToItem($item_id, $target_user_id, $count, [
    // optional parameters:
    'scenario' => <string>,
    'cascadeCreate' => <boolean>,
    'returnProperties' => <boolean>,
    'includedProperties' => <array>,
    'filter' => <string>,
    'booster' => <string>,
    'logic' => <string / array (map)>,
    'minRelevance' => <string>,
    'rotationRate' => <number>,
    'rotationTime' => <number>
  ])
);
?>

Copy

Initialization

RecommendationResponse result = client.Send(RecommendItemsToItem(string itemId, string targetUserId, long count,
    // optional parameters:
    scenario: <string>,
    cascadeCreate: <bool>,
    returnProperties: <bool>,
    includedProperties: <string[]>,
    filter: <string>,
    booster: <string>,
    logic: <Logic>,
    minRelevance: <string>,
    rotationRate: <double>,
    rotationTime: <double>
  )
);

Copy

Initialization

request := client.NewRecommendItemsToItem(itemId string, targetUserId string, count int)    
    // optional parameters:
    .SetScenario(scenario string)
    .SetCascadeCreate(cascadeCreate bool)
    .SetReturnProperties(returnProperties bool)
    .SetIncludedProperties(includedProperties []string)
    .SetFilter(filter string)
    .SetBooster(booster string)
    .SetLogic(logic bindings.Logic)
    .SetMinRelevance(minRelevance string)
    .SetRotationRate(rotationRate float64)
    .SetRotationTime(rotationTime float64)


result, err := request.Send() // result is of the type bindings.RecommendationResponse

Copy

GET /{databaseId}/recomms/items/{itemId}/items/?targetUserId=<string>
&count=<integer>
&scenario=<string>
&cascadeCreate=<boolean>
&returnProperties=<boolean>
&includedProperties=<array>
&filter=<string>
&booster=<string>
&logic=<string / Object>
&minRelevance=<string>
&rotationRate=<number>
&rotationTime=<number>

Since version

2.0.0

returnProperties

boolean

Located in: query

Required: No

Since version: 2.0.0

Example response:

  {
    "recommId": "0c6189e7-dc1a-429a-b613-192696309361",
    "recomms":
      [
        {
          "id": "tv-178",
          "values": {
            "description": "4K TV with 3D feature",
            "categories":   ["Electronics", "Televisions"],
            "price": 342,
            "url": "myshop.com/tv-178"
          }
        },
        {
          "id": "mixer-42",
          "values": {
            "description": "Stainless Steel Mixer",
            "categories":   ["Home & Kitchen"],
            "price": 39,
            "url": "myshop.com/mixer-42"
          }
        }
      ],
    "numberNextRecommsCalls": 0
  }