cluster

Yes

The cluster is that which has a relation to the entities.

entities

Yes

If there are no entities, there is no update.

num

Number

No

Number of times the update object applies. Defaults to 1.

what

String

Yes

The name of an action. Common values are BROWSE, PURCHASE, RECEXPOSURE and RECCLICK. This value is used to determine how the update will be handled.

data

Object

No

Extra information pertaining to the update. Some updates are triples (and not just simple cluster-entity relations), and may transport the extra information through this object.

where

String

No

Description of where the reported event took place. Most often, this is a short noun like app, web or email.

origin

String

No

Used for exposure and click reports. Should contain the name of the recommender from which an exposed or clicked recommendation originates.

tags

String list

No

Free-text one-word messages to the Recommender System. Tags be defined in cooperation with Sannsyn before use to have any effect.

time

Number

No

The time at which the event took place, given as a unix timestamp. If not present, arrival time at Sannsyn's servers will be used.

taxon

String

Yes

A taxon is like a label, telling what this single ID object refers to or represents. All taxa together form a taxonomy within a recommendations service.

id

String

Yes

taxon

String

Yes

ids

String list

Yes

OK

Boolean

Indicating whether everything has gone as expected

text

String

A short description of what has been done on the server

url

String

A URL pointing to relevant information [This field is only included when relevant, so do not expect it to be always present]

result

String list

origin

String

This is the ID that serves to identify the recommender algorithm that produced the recommendation results. Please use this string in the origin field in your exposure and click reports as described in the section about statistics reporting.