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

# Viewed object IDs

> Send a view event to capture viewed 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`

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

## 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.ViewedObjectIDs(
    "Product Viewed",
    "YourIndexName",
    new List<string> { "objectID-1", "objectID-2" }
  );
  ```

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

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

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

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

  ```js JavaScript theme={"system"}
  // This requires the `search-insights` library

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

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

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

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

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

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

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

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

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

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

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

  Insights.shared?.viewed(
    eventName: "Product Viewed",
    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>
