diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_api_keys.png b/src/connections/destinations/catalog/algolia-insights/images/algolia_api_keys.png new file mode 100644 index 0000000000..7a970ae2d9 Binary files /dev/null and b/src/connections/destinations/catalog/algolia-insights/images/algolia_api_keys.png differ diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_app_id_dropdown.png b/src/connections/destinations/catalog/algolia-insights/images/algolia_app_id_dropdown.png new file mode 100644 index 0000000000..d20fa8413e Binary files /dev/null and b/src/connections/destinations/catalog/algolia-insights/images/algolia_app_id_dropdown.png differ diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_dashboard_settings.png b/src/connections/destinations/catalog/algolia-insights/images/algolia_dashboard_settings.png new file mode 100644 index 0000000000..59fb29d9bb Binary files /dev/null and b/src/connections/destinations/catalog/algolia-insights/images/algolia_dashboard_settings.png differ diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_settings_menu.png b/src/connections/destinations/catalog/algolia-insights/images/algolia_settings_menu.png new file mode 100644 index 0000000000..70e2e77e57 Binary files /dev/null and b/src/connections/destinations/catalog/algolia-insights/images/algolia_settings_menu.png differ diff --git a/src/connections/destinations/catalog/algolia-insights/images/mapping_tab.png b/src/connections/destinations/catalog/algolia-insights/images/mapping_tab.png new file mode 100644 index 0000000000..263f4732ed Binary files /dev/null and b/src/connections/destinations/catalog/algolia-insights/images/mapping_tab.png differ diff --git a/src/connections/destinations/catalog/algolia-insights/images/mapping_tab_edit.png b/src/connections/destinations/catalog/algolia-insights/images/mapping_tab_edit.png new file mode 100644 index 0000000000..d5cf84fa43 Binary files /dev/null and b/src/connections/destinations/catalog/algolia-insights/images/mapping_tab_edit.png differ diff --git a/src/connections/destinations/catalog/algolia-insights/index.md b/src/connections/destinations/catalog/algolia-insights/index.md index 824b7d92cd..8616775f58 100644 --- a/src/connections/destinations/catalog/algolia-insights/index.md +++ b/src/connections/destinations/catalog/algolia-insights/index.md @@ -5,7 +5,7 @@ beta: true redirect_from: '/connections/destinations/catalog/algolia/' id: 5d373a350abf930001a6b70f --- -[Algolia Insights](https://www.algolia.com/products/analytics/) lets you push events related to how your product is being used. Sending those events is a required step for using several Algolia features: +This [Algolia Insights](https://www.algolia.com/products/analytics/) destination is a means of facilitating sending [Insights Events](https://www.algolia.com/doc/guides/sending-events/getting-started/). Sending these events is a required step for using several Algolia features: - Click and conversion analytics - A/B Testing @@ -24,31 +24,49 @@ This destination is maintained by [Algolia](https://www.algolia.com/). For any i 2. Search for "Algolia" in the Catalog, select it, and choose which of your sources to connect the destination to. 3. Enter the "App ID" & "API Key" into your Segment Settings UI which you can find on the Algolia Dashboard, under API Keys menu. -_**NOTE:** The Algolia Insights Destination is not a plug-and-play integration. It requires you to modify your frontend code to send additional Algolia-related data like index name, queryID, etc._ +To find your App ID, there are two options. You can find the App Id in the Application dropdown in the Dashboard. +![Application Dropdown](images/algolia_app_id_dropdown.png) -You can read more about how to send Algolia-related data to Segment from [the documentation at Algolia](https://www.algolia.com/doc/guides/sending-events/implementing/connectors/segment/). +The other location is where you will also find your API Keys. You can find your API Keys in your settings under API Keys, you will need a Search API Key to set up the Destination in Segment. +![Dashboard Settings](images/algolia_dashboard_settings.png) + +![Settings Menu](images/algolia_settings_menu.png) + +![Api Keys](images/algolia_api_keys.png) + +> _**NOTE:** The Algolia Insights Destination is not a plug-and-play integration. It requires you to modify your frontend code to send additional Algolia-related data like index name, queryID, etc._ + +To access your queryID, make sure clickAnalytics are enabled in your search event. If you're using Insights.js this will look like +```js +index.search('query', { + userToken: 'user-1', + clickAnalytics: true +}) +``` + +Once this is enabled you will be able to send properties like queryId in your segment events. You can read more about how to send Algolia-related data to Segment from [the documentation at Algolia](https://www.algolia.com/doc/guides/sending-events/implementing/connectors/segment/). + +## Mapping Events + +By default, Algolia has set up mappings for Product Clicked, Product Viewed and Order Completed events. If your event structure doesn't match [Segments V2 Ecommerce Spec](/docs/connections/spec/ecommerce/v2/) you can update this by using the Mapping Tab. + +![Mappings Tab](images/mapping_tab.png) + +![Edit Mappings](images/mapping_tab_edit.png) ## Track If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. -Algolia supports the following six events from Segment's [Ecommerce Spec](/docs/connections/spec/ecommerce/v2/). +Algolia supports the following events from Segment's [Ecommerce Spec](/docs/connections/spec/ecommerce/v2/). - - - - - - - - @@ -57,10 +75,6 @@ Algolia supports the following six events from Segment's [Ecommerce Spec](/docs/ - - - - @@ -70,23 +84,6 @@ Algolia supports the following six events from Segment's [Ecommerce Spec](/docs/ For a full list of required properties for each event type, see the [Spec: V2 Ecommerce Events](/docs/connections/spec/ecommerce/v2/) ```js -analytics.track('Product List Viewed', { - index: "my-index-name", - queryID: "Algolia queryID", // required only for Click Analytics, - products: [{ - objectID: "hit objectID", - // ... other required properties from the spec - }] -}) - -analytics.track('Product List Filtered', { - index: "my-index-name", - filters: [ - { type : "free_delivery", value: "true" } - ], - // ... other required properties from the spec -}) - analytics.track('Product Viewed', { objectID: "hit objectID", index: "my-index-name", @@ -94,7 +91,6 @@ analytics.track('Product Viewed', { // ... other required properties from the spec }) - analytics.track('Product Clicked', { objectID: "hit objectID", position: hitPositionOnIndex, // number @@ -103,13 +99,6 @@ analytics.track('Product Clicked', { // ... other required properties from the spec }) -analytics.track('Product Added', { - objectID: "hit objectID", - index: "my-index-name", - queryID: "Algolia queryID", // required only for Click Analytics, - // ... other required properties from the spec -}) - analytics.track('Order Completed', { index: "my-index-name", queryID: "Algolia queryID", // required only for Click Analytics, @@ -123,20 +112,4 @@ analytics.track('Order Completed', { }) ``` -Track calls will be sent to Algolia as a `track` event, and appear in your Click Analytics, A/B Testing and Personalization dashboard. - - -_**NOTE:** If you send anonymous activity to Algolia, it will not be connected to activity attributed to that same user once they are identified._ - - -## Renaming Events - -If you are already sending events of which the names are out of the spec, you need to rename them for Algolia to understand correctly. It doesn't necessarily mean you need to modify your code. - -Go to the destination settings and click "Rename Events". - -![Destination Settings](images/destination_settings.png) - -You can put your current event names on the left and the event names following the spec on the right. - -![Rename Events](images/rename_events.png) +> _**NOTE:** If you send anonymous activity to Algolia, it will not be connected to activity attributed to that same user once they are identified._
Supported Events Description
Product List ViewedFire this event when a visitor views a product list or category.
Product List FilteredFire this event when a visitor filters a product list or category.
Product Viewed Fire this event when a visitor views a product.Product Clicked Fire this event when a visitor clicks a product.
Product AddedFire this event when a visitor adds a product to their shopping cart.
Order Completed Fire this event whenever an order/transaction was successfully completed by the customer.