| version | | type | "integer" |
|---|
| required | true |
|---|
| description | "Version number. This field can be used to track changes in instrumentation that affect the nature of the data collected." |
|---|
|
|---|
| session | | type | "string" |
|---|
| description | "Session id" |
|---|
| required | true |
|---|
|
|---|
| token | | type | "string" |
|---|
| description | "Username for logged in users or session token for anonymous users" |
|---|
| required | true |
|---|
|
|---|
| suggestionId | | type | "string" |
|---|
| description | "A unique Suggestion identifier" |
|---|
| required | true |
|---|
|
|---|
| rank | | type | "integer" |
|---|
| description | "Position the Suggestion holds in the list of suggestions" |
|---|
| required | true |
|---|
|
|---|
| type | | type | "string" |
|---|
| description | "Type of the Suggestion" |
|---|
| enum | | "default" |
| "featured" |
| "discarded" |
| "favorite" |
| "category" |
| "personalized" |
| "unknown" |
|
|---|
| required | true |
|---|
|
|---|
| typeExtra | | type | "string" |
|---|
| description | "Additional information associated with the Suggestion type" |
|---|
| required | true |
|---|
|
|---|
| action | | type | "string" |
|---|
| description | "What action occured for a Suggestion:
* shown: Shown to user.
* accept: Accepted by user.
* discard: Discarded by user.
* favorite: Marked as a favorite by user." |
|---|
| enum | | "shown" |
| "accept" |
| "discard" |
| "favorite" |
|
|---|
| required | true |
|---|
|
|---|
| interfaceLanguage | | type | "string" |
|---|
| description | "The current interface language." |
|---|
| required | true |
|---|
|
|---|
| contentLanguage | | type | "string" |
|---|
| description | "Language code of current content language." |
|---|
| required | true |
|---|
|
|---|
| sourceLanguage | | type | "string" |
|---|
| description | "The source language code" |
|---|
| required | false |
|---|
|
|---|
| targetLanguage | | type | "string" |
|---|
| description | "The target language code" |
|---|
| required | false |
|---|
|
|---|
| sourceTitle | | type | "string" |
|---|
| description | "Source title" |
|---|
| required | false |
|---|
|
|---|
