Viewed Object IDs | iOS API Client V7 (Deprecated)

Deprecated content

This documentation is for a deprecated version of iOS API client. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of iOS API client for up-to-date information.

Required API Key: any key with the settings ACL

Method signature

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

See code examples

About this method

Send a view event to capture clicked items.

Examples

Copy

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'
  ]
);

1
2
3
4
5
6
7
8
9
10
insights = Algolia::Insights.new(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
)

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

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

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

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
Insights.register(
  context,
  "YourApplicationID",
  "YourSearchOnlyAPIKey",
  "user-1"
)

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

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

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

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

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

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

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

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

clientInsights.User(userToken).viewedObjectIDs(
    indexName = IndexName("indexName"),
    eventName = EventName("eventName"),
    objectIDs = listOf(ObjectID("objectID1"), ObjectID("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. 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?

Viewed Object IDs | iOS API Client V7 (Deprecated)

About this method

Examples

Parameters

Response

On this page