Clicked object IDs

Required ACL: search Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don’t use Algolia to build your category pages, use clickedObjectIDs. For details where this event is used, see Event types. Related methods:

clickedObjectIDsAfterSearch: track click events related to Algolia requests.
sendEvents: if you don’t want to send real-time events.

Examples

For more information about initializing the JavaScript Insights client aa, see Initialize the Insights client.

var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-123456");

insights.ClickedObjectIDs(
  "Product Clicked",
  "YourIndexName",
  new List<string> { "objectID-1", "objectID-2" }
);

client := insights.NewClient(
	"YourApplicationID",
	"YourSearchOnlyAPIKey",
).User("user-123456")

res, err := client.ClickedObjectIDs(
	"Product Clicked",
	"YourIndexName",
	[]string{"objectID-1", "objectID-2"},
)

UserInsightsClient insights = DefaultInsightsClient
    .create("YourApplicationID","YourSearchOnlyAPIKey")
    .user("user-123456");

insights.clickedObjectIDs(
  "Product Clicked",
  "YourIndexName",
  Arrays.asList("objectID-1", "objectID-2")
);

// This requires the `search-insights` library

aa("clickedObjectIDs", {
  userToken: "anonymous-123456", // required for Node.js
  authenticatedUserToken: "user-123456",
  index: "YourIndexName",
  eventName: "Product Clicked",
  objectIDs: ["objectID-1", "objectID-2"],
});

val userToken = UserToken("user-123456")

clientInsights.User(userToken).clickedObjectIDs(
    indexName = IndexName("YourIndexName"),
    eventName = EventName("Product Clicked"),
    objectIDs = listOf(ObjectID("objectID-1"), ObjectID("objectID-2"))
)

$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

$insights->user("user-123456")->clickedObjectIDs(
  'Product Clicked',
  'YourIndexName',
  ['objectID-1', 'objectID-2']
);

insights = InsightsClient.create("YourApplicationID", "YourSearchOnlyAPIKey")

insights.user("user-123456").clicked_object_ids(
    "Product Clicked", "YourIndexName", ["objectID-1", "objectID-2"]
)

insights = Algolia::Insights::Client.create("YourApplicationID", "YourSearchOnlyAPIKey")

insights.user("user-123456").clicked_object_ids(
  "Product Clicked",
  "YourIndexName",
  ["objectID-1", "objectID-2"]
)

client.execute {
  send event ClickedObjectIDs(
    "user-123456",
    "Product Clicked",
    "YourIndexName",
    Seq("objectID-1", "objectID-2")
  )
}

Insights.register(
  appId: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey",
  userToken: "user-123456"
)

Insights.shared?.clicked(
  eventName: "Product Clicked",
  indexName: "YourIndexName",
  objectIDs: ["objectID-1", "objectID-2"]
)

Parameters

eventName

string

required

Name of the specific event.Format: 1-64 ASCII characters, except control characters.To maximize the impact of your events, use consistent event names and consistent formatting, for example, “Product Added To Cart” (always in title case).For example, you can adopt Twilio Segment’s object-action framework.

indexName

string

required

Name of the Algolia index.Format: same as the index name used by the search engine.Some API clients use index instead of indexName.

objectIDs

string[]

required

List of object IDs for items of an Algolia index.You can include up to 20 object IDs.

userToken

string

required

Anonymous user identifier.See also: User token

authenticatedUserToken

string

Pseudonymous identifier for authenticated users.

Don’t include personally identifiable information in user tokens.

​Examples

​Parameters

Examples

Parameters