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

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

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# A

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# A

Copy

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

$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(
  'AJ0P3S7DWQ',
  '90dfaaf5755e694f341fe68f6e41a6d4',
)

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(
    'AJ0P3S7DWQ',
    '90dfaaf5755e694f341fe68f6e41a6d4'
)

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: "AJ0P3S7DWQ",
  apiKey: "90dfaaf5755e694f341fe68f6e41a6d4",
  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,
  "AJ0P3S7DWQ",
  "90dfaaf5755e694f341fe68f6e41a6d4",
  "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(
  "AJ0P3S7DWQ",
  "90dfaaf5755e694f341fe68f6e41a6d4"
).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("AJ0P3S7DWQ","90dfaaf5755e694f341fe68f6e41a6d4")
    .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(
	"AJ0P3S7DWQ",
	"90dfaaf5755e694f341fe68f6e41a6d4",
).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# 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. It's best to follow the 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 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# A

No response.

Did you find this page helpful?

Converted Objects IDs After Search | Ruby API Client V1 (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