API Reference / API Methods / Insights / Converted Objects IDs After Search

Feb. 26, 2019

Converted Objects IDs After Search

Required API Key: any key with the settings ACL

Method signature

$insights->user(string userToken)->convertedObjectIDsAfterSearch(
  string eventName,
  string indexName,
  array objectIDs,
  string queryID
)

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

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

insights.user(str userToken).converted_object_ids_after_search(
  str eventName,
  str indexName,
  list objectIDs,
  str queryID
)

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

suspend fun ClientInsights.User.clickedObjectIDsAfterSearch(
    indexName: IndexName,
    eventName: EventName,
    queryID: QueryID,
    objectIDs: List<ObjectID>,
    positions: List<Int>,
    timestamp: Long? = null
): HttpResponse

insights.convertedAfterSearch(
  String eventName,
  String indexName,
  List<String> queryID,
  EventObjects.IDs(objectIDs)
)

insights.User(String userToken).ConvertedObjectIDsAfterSearch(
  String eventName,
  String indexName,
  List<String> objectIDs,
  String queryID
)

insights.user(String userToken).convertedObjectIDsAfterSearch(
  String eventName,
  String indexName,
  List<String> objectIDs,
  String queryID
)

client.User(string userToken).ConvertedObjectIDsAfterSearch(
  string eventName,
  string indexName,
  []string objectIDs,
  string queryID,
)

send event ConvertedObjectIDsAfterSearch(
  String userToken,
  String eventName,
  String indexName,
  List<String> 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 search analytics. convertedObjectIDs only goes towards personalization.

You can find examples of click, conversion, and view events in the search analytics section.

Examples

Copy

$insights = Algolia\AlgoliaSearch\InsightsClient::create
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

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

insights = Algolia::Insights.new(
  'YourApplicationID',
  'YourSearchOnlyAPIKey',
)

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

// This requires installing the search-insights separate library:
// https://github.com/algolia/search-insights.js
// https://www.npmjs.com/package/search-insights

aa('convertedObjectIDsAfterSearch', {
  userToken: 'user-1',
  index: 'your_index_name',
  queryID: 'queryID',
  objectIDs: ['objectID1', 'objectID2']
});

insights = InsightsClient.create(
    'YourApplicationID',
    'YourSearchOnlyAPIKey'
)

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

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"
)

Insights.register(
  context,
  "YourApplicationID",
  "YourSearchOnlyAPIKey",
  "user-1"
)

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

var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-1");

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

UserInsightsClient insights = DefaultInsightsClient
    .create("YourApplicationID","YourSearchOnlyAPIKey")
    .user("user-1");

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

client := insights.NewClient(
	"YourApplicationID",
	"YourSearchOnlyAPIKey",
).User("user-1")

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

client.execute {
  send event ConvertedObjectIDsAfterSearch(
    "user-1",
    "your_event_name",
    "your_index_name",
    Seq("objectID1", "objectID2"),
    "queryID"
  )
}

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 char 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

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Converted Objects IDs After Search

About this method

Examples

Parameters

Response

Did you find this page helpful?

On this page