Category: Search Optimization AB Testing
This integration is only available for Web projects
What to expect
This integration will allow you to convert Algolia's result variants into Contentsquare dynamic variables, allowing you to segment and analyze users based on their search experiences. This integration is restricted to a single search index per project, and requires an implementation of the full Algolia library version 4+.
What we collect
Dynamic Variables
| Key | Value | Data Type |
| AB_AG_{Experiment ID} | {Variant Index Number} | Text |
AB_AG_{Experiment ID}
The dynamic variable's key is the experiment ID associated with the test, and the value is the index position of the variant (1 representing first variant, 2 representing the second, etc...). You can find these values in Algolia's AB test settings-
Implementation
Implementation Steps
Step 1
This integration requires implementing the full Algolia Javascript library version 4 and above. The lite version and older versions do not contain the required analytics capablities. For more information click here.
In order to enable the integration, you will need to provide Contentsquare with 4 parameters-
- An Algolia API Key with search and analytics permissions.
- The Algolia Application ID.
- The Algolia Analytics Region.
- The search index you wish to analyze.
Here is a quick guide how to retrieve these parameters:
Generating an analytics API Key
In the Algolia settings page, click the API Keys section-
Click the "All API Keys" tab, and then click the "New API Key" button.
Create a key with proper search index, and under "ACL" ONLY choose "Search" and "Analytics" permissions-
Back in the "All API Keys" tab, you'll find the API Key you generated. This is key you need to provide Contentsquare-
Important: Do not provide us an API key with administrative privileges . The required key would be exposed on a client facing code, and should have the minimal required permissions for the integration to work in order to avoid malicious usage.
Algolia Application ID
The Application ID can be found under the Algolia API Keys settings-
Analytics Region
Click the "Infrastructure" settings under "Organization Settings" in the Algolia settings-
And you'll find the region under the "Analytics" tab-
Send us back just the 2 character region code based on the indicator (Germany = "de", France = "fr", etc...).
Search Index
Please provide us the search index you are using, and wish to analyze (should correlate with the Application ID you are using, and the search index provided in the API Key you generated).
Once all the 4 required parameters have been acquired, continue to the second step.
Step 2
Please send an email to our support team with the information you gathered in the previous step, asking for the enablement of the Algolia integration.
Verifying it works
You can use the chrome extension to check the results are sent to CS
