Autocomplete
Log an autocomplete event
To capture the diversity of use cases our customer base, we allow several different types of autocomplete events to be communicated.
| Event | Meaning |
|---|---|
| focus | user focused on the autocomplete box |
| blur | user moved away from the autocomplete box |
| autocomplete_select | user selected autocomplete suggestion |
To log an event make a POST request to:
POST https://ac.cnstrc.com/v2/behavioral_action/<event_type>
where event_type is one of focus, blur, autocomplete_select.
Requests have to also include query string parameters
and body of the request has to have JSON object with the necessary fields, depending on event type (documented below).
Example
- Shell
- JavaScript
- Python
- Java
- iOS
- Android
- C#
Log an event
curl -X POST -H 'Content-Type: application/json' \
-u '[your token]:' \
"https://ac.cnstrc.com/v2/behavioral_action/focus? \
section=<section used for autocomplete> \
&key=<your API key> \
&c=<client id> \
&i=<user id> \
&s=<session number>" \
-d '{"user_input": "gear"}'
// This method is not currently supported.
# This method is not currently supported.
// This method is not currently supported.
// This method is not currently supported.
// This method is not currently supported.
// This method is not currently supported.
info
The above command returns a 204 Success response on success.
Query String Parameters
| Parameter | Type | Required? | Description |
|---|---|---|---|
| key | string | Yes | The key of the index you'd like to log events for. |
| c | string | Yes | Client id. The library responsible for making the request |
| i | string | Yes | User's device id. An anonymized user identification hash. |
| s | integer | Yes | Session number. The counter for the session in which the behavior event occurred. We recommend to increment the session number every 30 minutes |
| ui | string | No | Your internal ID for a user (if available) |
| _dt | integer | No | Unix timestamp in seconds of when the event happened |
| us | array of strings | No | User segment |
| section | string | No | Your autosuggest and search results can have multiple sections like "Products" and "Search Suggestions". This indicates which section was searched. See your dashboard for the section names to use. |
| origin_referrer | string | No | The url where the event originated. |
JSON Parameters
Focus
| Parameter | Type | Required? | Description |
|---|---|---|---|
| user_input | string | Yes | The text that a user had typed at the moment when they focused on autocomplete box |
Blur
| Parameter | Type | Required? | Description |
|---|---|---|---|
| user_input | string | Yes | The text that a user had typed at the moment when they moved away from autocomplete box |
Autocomplete select
| Parameter | Type | Required? | Description |
|---|---|---|---|
| user_input | string | Yes | The text that a user had typed at the moment when submitting search request |
| tr | string | Yes | Action that triggered the selection, one of click, tab, enter, valid-input |
| item_id | string | No | ID of the item that was selected (either it or item_name is required) |
| item_name | string | No | Name of the item that was selected (either it or item_id is required) |
| variation_id | string | No | ID of the variation that was shown to the user when the result was selected |
| group_id | string | No | Should be present when user selects a search suggestion that automatically applies a group_id filter |