Examples are given in JSON format. SuggestGrid API Clients use the same structures in their conventions. Refer to their documentations for examples.

Actions are the format SuggestGrid uses to learn from your application.

An action must have a 'type' (string), a 'user id' (string or integer) and an 'item id' (string or integer). Explicit actions must also have a 'rating' (float number or integer) parameter. Whether an action is implicit or explicit depends on the type it belongs to.

Actions could also have a 'timestamp' parameter with a long UNIX epochtime value. When timestamp is not provided actions are recorded with the current time.

An implicit action example is below:

{"type": "views", "user_id": "a35", "item_id": "xda-3268314"}

This action could mean that user with id "a35" viewed the item with id "xda-3268314".

An explicit action example is below:

{"type": "rating", "user_id": 101 "item_id": 99, "rating": 5}

This action could mean that user 101 gave item 99 a rating of 5.

Optionally, actions could be send in bulk.

You can discover the actions sent to SuggestGrid with get the actions method. You can view the latest actions, and filter them by type, date, user id, or item id.

Note that the type of actions must be created before any actions are sent to them.

You can see all the actions you've sent to SuggestGrid on your dashboard.

SuggestGrid keeps all the actions sent in order to use them for analytics as well. For implicit types the number of actions a user-item pair has means a higher correlation for recommendations. On the contary, SuggestGrid only uses the latest actions for explicit types, if a user-item pair has more than one action.

In order to get the best recommendations we recommend to send your actions and have your models generated.