Viewed Object IDs | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: any key with the settings ACL

Method signature

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

See code examples

About this method# A

Send a view event to capture clicked items.

Examples# A

Edit

Copy

Copy
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'AJ0P3S7DWQ',
  '90dfaaf5755e694f341fe68f6e41a6d4'
);

$insights->user("userToken")->viewedObjectIDs(
  'your_event_name',
  'your_index_name',
  [
    'objectID1',
    'objectID2'
  ]
);

Copy
insights = Algolia::Insights.new(
  'AJ0P3S7DWQ',
  '90dfaaf5755e694f341fe68f6e41a6d4'
)

insights.user('userToken').viewed_object_ids(
  'your_event_name',
  'your_index_name',
  ['objectID1', 'objectID2']
)

Copy
// This requires installing the search-insights separate library
// https://github.com/algolia/search-insights.js
// https://www.npmjs.com/package/search-insights
// Compatible with Node.js since v1.3.0

aa('viewedObjectIDs', {
  userToken: "user-1",
  index: 'your_index_name',
  eventName: 'your_event_name',
  objectIDs: ['objectID1', 'objectID2']
});

Copy
insights = InsightsClient.create(
    'AJ0P3S7DWQ',
    '90dfaaf5755e694f341fe68f6e41a6d4'
)

insights.user('user-1').viewed_object_ids(
    'your_event_name',
    'your_index_name',
    ['objectID1', 'objectID2']
)

Copy
Insights.register(
  appId: "AJ0P3S7DWQ",
  apiKey: "90dfaaf5755e694f341fe68f6e41a6d4",
  userToken: "user-1"
)

Insights.shared?.viewed(
  eventName: "your_event_name",
  indexName: "your_index_name",
  objectIDs: ["objectID1", "objectID2"]
)

Copy
Insights.register(
  context,
  "AJ0P3S7DWQ",
  "90dfaaf5755e694f341fe68f6e41a6d4",
  "user-1"
)

Insights.shared?.viewed(
  "your_event_name",
  "your_index_name",
  EventObjects.IDs("objectID1", "objectID2")
)

Copy
var insights = new InsightsClient(
  "AJ0P3S7DWQ",
  "90dfaaf5755e694f341fe68f6e41a6d4"
).User("user-1");

insights.ViewedObjectIDs(
  "your_event_name",
  "your_index_name",
  new List<string> { "objectID1", "objectID2" }
);

Copy
UserInsightsClient insights = DefaultInsightsClient
    .create("AJ0P3S7DWQ","90dfaaf5755e694f341fe68f6e41a6d4")
    .user("user-1");

insights.viewedObjectIDs(
  "your_event_name",
  "your_index_name",
  Arrays.asList("objectID1", "objectID2")
);

Copy
client := insights.NewClient(
	"AJ0P3S7DWQ",
	"90dfaaf5755e694f341fe68f6e41a6d4",
).User("user-1")

res, err := client.ViewedObjectIDs(
	"your_event_name",
	"your_index_name",
	[]string{"objectID1", "objectID2"},
)

Copy
val userToken = UserToken("user-id")

clientInsights.User(userToken).viewedObjectIDs(
    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_-] Length: between 1 and 64 characters.
`eventName` #	type: string Required Name of the event. Format: any ascii char except control characters. Length: between 1 and 64 characters.
`indexName` #	type: string Required Name of the index related to the view.
`objectIDs` #	type: string[] Required A list of objectIDs. Limited to 20 objectIDs.

Response# A

No response.

Did you find this page helpful?

Viewed Object IDs | JavaScript API Client V3 (Deprecated)

About this method# Found an issue? Edit this guide A Edit this guide

Examples# Found an issue? Edit this guide A Edit this guide

Parameters# Found an issue? Edit this guide A Edit this guide

Response# Found an issue? Edit this guide A Edit this guide

On this page

About this method# A

Examples# A

Parameters# A

Response# A