Viewed object IDs

Required API Key: any key with the search ACL

Method signature

$insights->user(string userToken)->viewedObjectIDs(
  string eventName,
  string indexName,
  array objectIDs
)

insights.user(String userToken).viewed_object_ids(
  String eventName,
  String indexName,
  Array objectIDs
)

aa('viewedObjectIDs', {
  userToken: string,
  authenticatedUserToken: string,
  index: string,
  eventName: string,
  objectIDs: array
});

insights.user(str userToken).viewed_object_ids(
  str eventName,
  str indexName,
  list objectIDs
)

insights.viewed(
  eventName: String,
  indexName: String,
  objectIDs: [String],
  userToken: String
)

suspend fun ClientInsights.User.viewedObjectIDs(
    indexName: IndexName,
    eventName: EventName,
    objectIDs: List<ObjectID>,
    timestamp: Long? = null
): HttpResponse

insights.User(String userToken).ViewedObjectIDs(
  String eventName,
  String indexName,
  List<String> objectIDs
)

insights.user(String userToken).viewedObjectIDs(
  String eventName,
  String indexName,
  List<String> objectIDs
)

client.User(userToken).ViewedObjectIDs(
  string eventName,
  string indexName,
  []string objectIDs,
)

send event ViewedObjectIDs(
  String userToken,
  String eventName,
  String indexName,
  Iterable<String> objectIDs
)

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Send a view event to capture viewed items.

Sending this event is useful for:

Personalization

Guides Get started with click and conversion events

Send click and conversion events with InstantSearch

Send click and conversion events with Autocomplete

API Insights API

Examples

Read the Algolia CLI documentation for more information.

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

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

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

1
2
3
4
5
6
7
insights = Algolia::Insights::Client.create('YourApplicationID', 'YourSearchOnlyAPIKey')

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

1
2
3
4
5
6
7
8
9
// 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']
});

1
2
3
4
5
6
7
8
9
10
insights = InsightsClient.create(
    "YourApplicationID",
    "YourSearchOnlyAPIKey"
)

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

1
2
3
4
5
6
7
8
9
10
11
Insights.register(
  appId: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey",
  userToken: "user-123456"
)

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

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

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

1
2
3
4
5
6
7
8
9
10
var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-123456");

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

1
2
3
4
5
6
7
8
9
UserInsightsClient insights = DefaultInsightsClient
    .create("YourApplicationID","YourSearchOnlyAPIKey")
    .user("user-123456");

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

1
2
3
4
5
6
7
8
9
10
client := insights.NewClient(
	"YourApplicationID",
	"YourSearchOnlyAPIKey",
).User("user-123456")

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

Parameters

Parameter	Description
`userToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Required Anonymous user identifier. See also: User Token
`authenticatedUserToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Optional Pseudonymous identifier for authenticated users. Never include personally identifiable information in user tokens. See also: User Token
`eventName`	type: string pattern: `[\x20-\x7E]{1,64}` 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 Segment’s object-action framework.
`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`.
`objectIDs`	type: array items: string Required List of object identifiers for items of an Algolia index. You can include up to 20 `objectID`.

Response

This method doesn't return a response.

Did you find this page helpful?

Viewed object IDs

About this method

Examples

Parameters

Response

On this page