Converted Objects IDs After Search | Ruby API Client V1 (Deprecated)

Deprecated content

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

Required API Key: any key with the settings ACL

Method signature

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

See code examples

About this method

Send a conversion event to capture a query and its clicked items.

Note that unlike convertedObjectIDs, convertedObjectIDsAfterSearch takes a queryID. Therefore, the captured event goes towards both Personalization and Click and Conversion Analytics. convertedObjectIDs only goes towards personalization.

You can find examples of click, conversion, and view events in the Search Analytics section.

Examples

Copy

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

$insights->user("user-1")->convertedObjectIDsAfterSearch(
  'your_event_name',
  'your_index_name',
  ['objectID1', 'objectID2'],
  'queryID'
);

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

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

1
2
3
4
5
6
7
8
9
10
11
12
// 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('convertedObjectIDsAfterSearch', {
  userToken: 'user-1',
  eventName: 'your_event_name',
  index: 'your_index_name',
  queryID: 'queryID',
  objectIDs: ['objectID1', 'objectID2']
});

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

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

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

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

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

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

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

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

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

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

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

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

1
2
3
4
5
6
7
8
9
client.execute {
  send event ConvertedObjectIDsAfterSearch(
    "user-1",
    "your_event_name",
    "your_index_name",
    Seq("objectID1", "objectID2"),
    "queryID"
  )
}

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

clientInsights.User(userToken).clickedObjectIDsAfterSearch(
    indexName = IndexName("indexName"),
    eventName = EventName("eventName"),
    objectIDs = listOf(ObjectID("objectID1"), ObjectID("objectID2")),
    positions = listOf(17, 19),
    queryID = QueryID("queryID")
)

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 conversion.
`objectIDs`	type: string[] Required A list of objectIDs. Limited to 20 objectIDs.
`queryID`	type: string Required Algolia queryID, format: [a-z1-9]{32}.

Response

No response.

Did you find this page helpful?

Converted Objects IDs After Search | Ruby API Client V1 (Deprecated)

About this method

Examples

Parameters

Response

On this page