> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Clicked object IDs

> Send a click event to capture clicked items.

export const Legacy = ({title, href}) => {
  return <Note>

    This page documents an earlier version of the API client.
    For the latest version, see <a href={href}>{title}</a>.

    </Note>;
};

<Legacy title="Send events" href="/doc/libraries/sdk/methods/insights/push-events" />

**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](/doc/guides/solutions/ecommerce/browse/tutorials/category-pages),
use `clickedObjectIDs`.

For details where this event is used, see [Event types](/doc/guides/sending-events/concepts/event-types).

**Related methods:**

* [`clickedObjectIDsAfterSearch`](/doc/libraries/sdk/v1/methods/clicked-object-ids-after-search): track click events **related to Algolia requests**.
* [`sendEvents`](/doc/libraries/sdk/v1/methods/send-events): 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](/doc/libraries/search-insights/init).

<CodeGroup>
  ```cs C# theme={"system"}
  var insights = new InsightsClient(
    "YourApplicationID",
    "YourSearchOnlyAPIKey"
  ).User("user-123456");

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

  ```go Go theme={"system"}
  client := insights.NewClient(
  	"YourApplicationID",
  	"YourSearchOnlyAPIKey",
  ).User("user-123456")

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

  ```java Java theme={"system"}
  UserInsightsClient insights = DefaultInsightsClient
      .create("YourApplicationID","YourSearchOnlyAPIKey")
      .user("user-123456");

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

  ```js JavaScript theme={"system"}
  // 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"],
  });
  ```

  ```kotlin Kotlin theme={"system"}
  val userToken = UserToken("user-123456")

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

  ```php PHP theme={"system"}
  $insights = Algolia\AlgoliaSearch\InsightsClient::create(
    'YourApplicationID',
    'YourSearchOnlyAPIKey'
  );

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

  ```python Python theme={"system"}
  insights = InsightsClient.create("YourApplicationID", "YourSearchOnlyAPIKey")

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

  ```ruby Ruby theme={"system"}
  insights = Algolia::Insights::Client.create("YourApplicationID", "YourSearchOnlyAPIKey")

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

  ```scala Scala theme={"system"}
  client.execute {
    send event ClickedObjectIDs(
      "user-123456",
      "Product Clicked",
      "YourIndexName",
      Seq("objectID-1", "objectID-2")
    )
  }
  ```

  ```swift Swift theme={"system"}
  Insights.register(
    appId: "YourApplicationID",
    apiKey: "YourSearchOnlyAPIKey",
    userToken: "user-123456"
  )

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

## Parameters

<ParamField body="eventName" type="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](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework).
</ParamField>

<ParamField body="indexName" type="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`.
</ParamField>

<ParamField body="objectIDs" type="string[]" required>
  List of object IDs for items of an Algolia index.

  You can include up to 20 object IDs.
</ParamField>

<ParamField body="userToken" type="string" required>
  Anonymous user identifier.

  See also: [User token](/doc/guides/sending-events/concepts/usertoken)
</ParamField>

<ParamField body="authenticatedUserToken" type="string">
  Pseudonymous identifier for authenticated users.

  <Warning>
    Don't include personally identifiable information in user tokens.
  </Warning>

  See also: [User token](/doc/guides/sending-events/concepts/usertoken)
</ParamField>