-
Notifications
You must be signed in to change notification settings - Fork 0
Algolia insights update docs #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
@@ -24,31 +24,37 @@ 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Enter the "App ID" & "API Key" into your Segment Settings UI which you can find on the Algolia Dashboard, under API Keys menu.
Can we show a screenshot of where these items are in the Algolia Dashboard?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep will add those in today! Makes a lot of sense to show where they're located
}) | ||
``` | ||
|
||
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/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call linking to our docs.
|
||
## 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 the spec you can update this by using the Mapping Tab. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Read from top to bottom, the reader doesn't know what 'the spec' is at this point in the document. We should either more the explination of that up to this point from below.
For a full list of required properties for each event type, see the Spec: V2 Ecommerce Events
Or this should be reworded to not include a reference to 'the spec'.
It'd also be reasonable to simply repeat ourselves here and lower in the document where we use the fully worded "Spec: V2 Ecommerce Events" and link to the ecommerce 2.0 events spec.
@@ -126,17 +103,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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a strange line. Can you make heads or tails of it? Insights events are not sent to Algolia "as a track event". They are sent to us as… "events". They have an eventType
field, but those are one of 'view', 'click' or 'conversion'. I think this needs to be reworded or removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah this was in the original documentation, I thought it was just me not fully understanding it. I'll just remove this entirely
remove irrelevant sentence
Proposed changes
Merge timing
Related issues (optional)