API Reference / API Methods / Insights / Clicked Object IDs
Required API Key: any key with the settings ACL
Method signature
suspend fun ClientInsights.User.clickedObjectIDs(
    indexName: IndexName,
    eventName: EventName,
    objectIDs: List<ObjectID>,
    timestamp: Long? = null
): HttpResponse

About this method # A

Send a click event to capture clicked items.

Note that unlike clickedObjectIDsAfterSearch, clickedObjectIDs doesn’t take a queryID. Therefore, clickedObjectID events only go towards personalization. clickedObjectIDsAfterSearch events go towards both personalization and Search Analytics.

You can find examples of click, conversion, and view events in the Search Analytics section.

Examples # A

1
2
3
4
5
6
7
val userToken = UserToken("user-id")

clientInsights.User(userToken).clickedObjectIDs(
    indexName = IndexName("indexName"),
    eventName = EventName("eventName"),
    objectIDs = listOf(ObjectID("objectID1"), ObjectID("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 click.

objectIDs #
type: string[]
Required

A list of objectIDs.

Limited to 20 objectIDs.

Response # A

No response

Did you find this page helpful?
Kotlin v2