Converted object IDs after search

Required API Key: any key with the search 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,
    authenticatedUserToken: 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.convertedObjectIDsAfterSearch(
    indexName: IndexName,
    eventName: EventName,
    queryID: QueryID,
    objectIDs: List<ObjectID>,
    timestamp: Long? = null
): HttpResponse

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,
  Iterable<String> objectIDs,
  String queryID
)

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Send a conversion event related to an Algolia request.

Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, users add the item to their shopping cart.

If you use Algolia to build your category pages, you’ll also use the convertedObjectIDsAfterSearch event.

Sending this event is useful for:

Related methods:

convertedObjectIDs: track conversion events not related to Algolia requests.
sendEvents: if you don’t want to send real-time events.

Guides Get started with click and conversion events

Send click and conversion events with InstantSearch

Send click and conversion events with Autocomplete

API Insights API

Examples

Read the Algolia CLI documentation for more information.

For more information about initializing the Insights client aa, see Initialize the Insights client.

Copy

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

$insights->user("user-123456")->convertedObjectIDsAfterSearch(
  'Product Converted',
  'YourIndexName',
  ['objectID-1', 'objectID-2'],
  'queryID'
);

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

insights.user('user-123456').converted_object_ids_after_search(
  'Product Converted',
  'YourIndexName',
  ['objectID-1', 'objectID-2'],
  'queryID'
)

1
2
3
4
5
6
7
8
9
10
// This requires the `search-insights` library

aa('convertedObjectIDsAfterSearch', {
  userToken: 'anonymous-123456', // required for Node.js
  authenticatedUserToken: 'user-123456',
  eventName: 'Product Converted',
  index: 'YourIndexName',
  queryID: 'queryID',
  objectIDs: ['objectID-1', 'objectID-2']
});

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

insights.user("user-123456").converted_object_ids_after_search(
    "Product Converted",
    "YourIndexName",
    ["objectID-1", "objectID-2"],
    "queryID"
)

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

Insights.shared?.convertedAfterSearch(
  eventName: "Product Converted",
  indexName: "YourIndexName",
  objectIDs: ["objectID-1", "objectID-2"],
  queryID: "queryID"
)

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

clientInsights.User(userToken).convertedObjectIDsAfterSearch(
    indexName = IndexName("YourIndexName"),
    eventName = EventName("Product Converted"),
    objectIDs = listOf(ObjectID("objectID-1"), ObjectID("objectID-2")),
    queryID = QueryID("queryID")
)

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

insights.ConvertedObjectIDsAfterSearch(
  "Product Converted",
  "YourIndexName",
  new List<string> { "objectID-1", "objectID-2" },
  "queryId"
);

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

insights.convertedObjectIDsAfterSearch(
  "Product Converted",
  "YourIndexName",
  Arrays.asList("objectID-1", "objectID-2"),
  "queryID"
);

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

res, err := client.ConvertedObjectIDsAfterSearch(
	"Product Converted",
	"YourIndexName",
	[]string{"objectID-1", "objectID-2"},
	"queryID"
)

1
2
3
4
5
6
7
8
9
client.execute {
  send event ConvertedObjectIDsAfterSearch(
    "user-123456",
    "Product Converted",
    "YourIndexName",
    Seq("objectID-1", "objectID-2"),
    "queryID"
  )
}

Parameters

Parameter	Description
`userToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Required Anonymous user identifier. See also: User Token
`authenticatedUserToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Optional Pseudonymous identifier for authenticated users. Never include personally identifiable information in user tokens. See also: User Token
`eventName`	type: string pattern: `[\x20-\x7E]{1,64}` Required Name of the specific event. Format: 1-64 ASCII characters, except control characters. To maximize the impact of your events, use consistent event names and consistent formatting—for example, “Product Added To Cart” (always in title case). For example, you can adopt Segment’s object-action framework.
`indexName`	type: string Required Name of the Algolia index. Format: same as the index name used by the search engine. Some API clients use `index` instead of `indexName`.
`objectIDs`	type: array items: string Required List of object identifiers for items of an Algolia index. You can include up to 20 `objectID`.
`queryID`	type: string pattern: `[a-f0-9]{32}` Required Unique identifier for a search query. A `queryID` is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the `queryID` is included in the API response. See also: Keep track of query IDs

Response

This method doesn't return a response.

Did you find this page helpful?

Converted object IDs after search

About this method

Examples

Parameters

Response

On this page