API Reference / API Methods / Insights / Viewed Object IDs
Feb. 26, 2019

Viewed Object IDs

Required API Key: any key with the settings ACL
Method signature
$insights->user(string userToken)->viewedObjectIDs(
  string eventName,
  string indexName,
  array objectIDs
)

About this method

Send a view event to capture clicked items.

Examples

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

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

Parameters

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.

We strongly encourage you to follow our event naming guidelines.

Format: any ASCII character 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

No response

Did you find this page helpful?