API Reference / API Methods / Insights / Viewed Object IDs
Required API Key: any key with the settings ACL
Method signature
send event ViewedObjectIDs(
  String userToken,
  String eventName,
  String indexName,
  List<String> objectIDs
)

About this method # A

Send a view event to capture viewed items.

Examples # A

1
2
3
4
5
6
7
8
client.execute {
  send event ViewedObjectIDs(
    "user-1",
    "your_event_name",
    "your_index_name",
    Seq("objectID1", "objectID2")
  )
}

Parameters # A

userToken #
type: string
Required

A user identifier.

Format: alpha numeric string [a-zA-Z0-9_-=/+]{1,128}

Length: between 1 and 64 characters.

eventName #
type: string
Required

Name of the event.

It’s best to follow the event naming guidelines.

Format: any ASCII character except control characters.

Length: between 1 and 64 characters.

indexName #
type: string
Required

Name of the index related to the view.

objectIDs #
type: string[]
Required

A list of objectIDs.

Limited to 20 objectIDs.

Response # A

No response

Did you find this page helpful?
Scala v1