You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Kameleoon updated their HackMD doc - updated docs accordingly
HackMD:https://hackmd.io/tp-iUR10TAqKSTcYi5Rd1g?view
* Apply suggestions from code review
* Apply suggestions from code review
* Fixed the image that appears in the Amazon S3 documentation
* [LiveIntent Audiences] new destination documentation
* Delete src/connections/destinations/catalog/tableau directory
Updating documentation because Tableau isn't a destination we support. Tableau is a BI tool that can be used on top of a warehouse to visualize and analyze data. Setting up Tableau to a warehouse would be configured directly through Tableau. Customer should reach out to Tableau for support.
* Update src/connections/destinations/catalog/kameleoon/index.md
I've verified with the customer to remove the api name`Kameleoon.API.Visitor.code`
Co-authored-by: stayseesong <[email protected]>
* fix(content): minor grammar / spelling suggestions while reviewing (#2299)
* Update index.md
* update incorrect description of a few fields (#2300)
The description of a few fields were incorrect, the description of the business hours were switched with out-of-business hours:
requester_wait_time_in_minutes_calendar
requester_wait_time_in_minutes_business
on_hold_time_in_minutes_calendar
on_hold_time_in_minutes_business
This was confirmed by looking at the examples here : https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/
* updates requested from partner (#2304)
* Display links for partner owned components (#2305)
* Add the NPM option to A.js quickstart (#2306)
Co-authored-by: charholt <[email protected]>
Co-authored-by: Charity Holt <[email protected]>
Co-authored-by: stayseesong <[email protected]>
Co-authored-by: forstisabella <[email protected]>
Co-authored-by: Thomas Gilbert <[email protected]>
Co-authored-by: Yimeng Yu <[email protected]>
Co-authored-by: Jason Sooter <[email protected]>
Co-authored-by: Atif Javed <[email protected]>
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/kameleoon/index.md
+11-10Lines changed: 11 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Kameleoon Destination
3
3
rewrite: true
4
4
---
5
5
6
-
[Kameleoon](https://kameleoon.com/en)provides GDPR, CCPA, and HIPAA compliant A/B testing, full stack, and AI-powered personalization solutions to help marketers, product owners, and developers maximize customer engagement and conversion - all from a single platform.
6
+
[Kameleoon’s](https://kameleoon.com/en)powerful and easy-to-use A/B testing, full stack, and AI-powered personalization solutions help marketers, product owners, and developers maximize customer engagement and conversion all from a single platform.
7
7
8
8
This destination is maintained by Kameleoon. For any issues with the destination, [contact the Kameleoon Support team](mailto:[email protected]).
9
9
@@ -18,34 +18,37 @@ Segment’s Kameleoon destination supports the following Kameleoon products:
18
18
*[Kameleoon AI Personalization](https://www.kameleoon.com/en/platform/personalization){:target="_blank"} (Web Client-side)
In order to use the Kameleoon & Segment.io integration, you first need to request an API Key. Send your request it to [[email protected]](mailto:[email protected]), and be sure to specify your Kameleoon account login.
22
22
23
23
You will also need the **sitecode** key. You can find it in your Kameleoon account, as described in [How do I find my site id?](https://help.kameleoon.com/question/how-do-i-find-my-site-id/){:target="_blank"}.
24
24
25
25
To add the destination to your Segment workspace:
26
26
27
27
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
28
-
2. Search for "Kameleoon" in the Destinations Catalog, and select the Kameleoon destination.
29
-
3. Choose which Source should send data to the Kameleoon destination.
28
+
2. Search for **Kameleoon** in the Destinations Catalog, and select the **Kameleoon** destination.
29
+
3. Choose which Source should send data to the **Kameleoon** destination.
30
30
4. Enter the **API Key** and the **sitecode** in the Kameleoon destination settings in Segment.
31
31
32
32
## Implementation pre-requisites: matching Users between Kameleoon and Segment
33
33
34
-
The integration requires you to use the same system of identifiers for both tools, meaning the `userId` value you pass to Segment should be the same value that Kameleoon uses to identify a "visitor". If you use Kameleoon Experiment or Kameleoon AI Personalization on your website, Kameleoon places a cookie that contains an anonymous unique identifier, called the Kameleoon visitorcode, randomly assigned to a visitor. This ID is used to uniquely identify a browser.
34
+
The integration requires you to use the same system of identifiers for both tools, meaning the `userId` value you pass to Segment should be the same value as Kameleoon uses to identify a “visitor”.
35
35
36
-
Check with your engineers to ensure Kameleoon's `visitorcode` is passed in the `userId` property of the Segment calls to ensure Kameleoon can consolidate data and avoid any analytics discrepancies between the tools in your campaign results.
36
+
If you use Kameleoon Experiment or Kameleoon AI Personalization on your website, Kameleoon places a cookie that contains an anonymous unique identifier, called the Kameleoon visitorcode. This ID is randomly assigned to a visitor and is used to uniquely identify a browser.
37
37
38
-
To provide a consistent user identifier to Kameleoon, you may specify in Segment calls a user property, `k_visitorCode`, whose value is the Kameleoon visitorcode. You can retrieve the user visitorCode from the browser by using Kameleoon's [Activation API](https://developers.kameleoon.com/activation-api.html#visitor){:target="_blank"}.
38
+
You can either pass Kameleoon's visitorcode in the userId property of the Segment calls to ensure Kameleoon can consolidate data and avoid any analytics discrepancies between the tools in your campaign results, OR you may specify in all Segment calls an additional user property, `k_visitorCode`, whose value is the Kameleoon visitorcode. You can retrieve the user visitorCode from the browser by using Kameleoon's [Activation API](https://developers.kameleoon.com/activation-api.html#visitor){:target="_blank"}.
39
39
40
-
If you use Kameleoon Full Stack, please refer to the [Kameleoon SDK documentation](https://developers.kameleoon.com/sdks-overview.html){:target="_blank"}.
40
+
If you are not able to update your existing Segment tracking plan, you can also pass Kameleoon's visitor code in an additional Segment call as follows: `analytics.track('Kameleoon identifier', {'k_visitorCode': Kameleoon.API.Visitor.code});Kameleoon`. This will automatically link your internal user ID or anonymous ID to Kameleoon's own visitorCode. Make sure to call it only once per session.
41
41
42
+
If you use Kameleoon Full Stack, please refer to the [Kameleoon SDK documentation](https://developers.kameleoon.com/sdks-overview.html){:target="_blank"}. Kameleoon recommends you to use your own internal ID to identify users.
42
43
43
44
## Supported methods
44
45
45
46
Kameleoon supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
46
47
48
+
47
49
If the Segment event name matches exactly the name of an existing [goal](https://help.kameleoon.com/create-new-goal/){:target="_blank"} in your Kameleoon account, a conversion for this goal will be associated to the visitor. If the goal does not exist, Kameleoon will create a [custom goal](https://help.kameleoon.com/create-new-goal/#Custom_goal){:target="_blank"} by using the Segment event name and associate the conversion to the visitor. The goal will appear in the Kameleoon [goals page](https://help.kameleoon.com/manage-goals/){:target="_blank"} with the name convention 'SegmentIO eventType - eventName'. Once the goal has been created, you can use them in any of your [campaign](https://help.kameleoon.com/set-up-goal-campaign/){:target="_blank"}.
48
50
51
+
49
52
### Page
50
53
51
54
Send [Page](/docs/connections/spec/page/) calls to record whenever a user sees a page of your website, along with any optional properties about the page. Calling page or screen in a source is one of the first steps to getting started with Segment.
LiveIntent Audiences supports audiences generated by Segment Personas as a user property. To use this destination, you need to have Segment’s Business Tier plan which gives you access to [Personas][/docs/personas/].
8
+
9
+
If you don’t have access to Personas but still want to send data to LiveIntent, you can use the [Page][/docs/connections/spec/page], [Screen][/docs/connections/spec/screen/], [Track][/docs/connections/spec/track/], [Identify][/docs/connections/spec/identify/], and [Group][/docs/connections/spec/group/] calls. For more information about sending your data to LiveIntent via direct calls (to Page, Screen, Track, Identify, and Group), please reach out to your LiveIntent customer success representative.
10
+
11
+
LiveIntent maintains this destination. For more information about this destination, [contact the LiveIntent Support team](mailto:[email protected]).
12
+
13
+
## Getting Started
14
+
15
+
{% include content/connection-modes.md %}
16
+
17
+
Before getting started, you need to request an API Key and AppId by sending an email to LiveIntent support at `[email protected]`.
18
+
19
+
Once you have your API Key and APP ID:
20
+
1. Navigate to the Destinations catalog page in the Segment App and click **Add Destination**.
21
+
2. Search for **LiveIntent** in the Destinations Catalog, and select the LiveIntent Audiences destination.
22
+
3. Choose which Source should send data to the LiveIntent Audiences destination.
23
+
4. Enter the API Key and AppId that you received from LiveIntent in the LiveIntent Audiences destination settings page in Segment.
24
+
25
+
When you set up this destination for a Segment Personas audience, provide the snake_cased version of the audience name in the Audience settings. You can send audiences generated using Segment Personas to this destination as a user property. If no corresponding audience exists in LiveIntent’s platform, one will automatically create.
| Audiences | If you use this destination for an audience generated using Segment Personas, specify the snake-cased name of the Segment audience; otherwise, the setting is invalid |
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/libraries/website/javascript/quickstart.md
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,10 @@ Next create an Analytics.js source from your Workspace:
22
22
When you create a Source in the Segment web app, it tells the Segment servers that you'll be sending data from a specific source type. When you create (or change!) a Source in the Segment app, Segment generates a new Write Key for that source. You use the write key in your website code to tell Segment servers where the data is coming from, so Segment can route it to your Destinations and other tools.
23
23
24
24
25
-
## Step 2: Copy the Segment Snippet
25
+
## Step 2: Add the Segment Snippet
26
+
27
+
> success "Install Segment as an NPM package"
28
+
> You can add Segment to your project as an [NPM package](https://www.npmjs.com/package/@segment/snippet){:target="_blank"}. For more information, see the instructions on [GitHub](https://github.com/segmentio/analytics-next#-using-as-an-npm-package){:target="_blank"}.
26
29
27
30
Paste this snippet into the `<head>` tag of your site to install Segment.
Copy file name to clipboardExpand all lines: src/connections/storage/catalog/amazon-s3/index.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ To migrate to the AWS S3 destination, follow the instructions outlined in the ["
23
23
24
24
You can view the AWS S3 destination in the Storage Destinations catalog.
25
25
26
-
26
+
27
27
28
28
> error " "
29
29
> You need to migrate to the new S3 destination before you disable your legacy destination to ensure Segment continues to deliver data to your S3 bucket.
Copy file name to clipboardExpand all lines: src/personas/identity-resolution/identity-resolution-onboarding.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -17,12 +17,12 @@ Segment creates and merges user profiles based on a space's Identity Resolution
17
17
18
18
### Flat matching logic
19
19
20
-
When Personas receives a new event, Segment looks for any profiles that match any of the identifiers on the event.
20
+
When Personas receives a new event, Segment looks for profiles that match any of the identifiers on the event.
21
21
22
22
Based on the existence of a match, one of three actions can occur:
23
23
24
24
**1: Create a new profile**
25
-
When there are no pre-existing profiles that have matching identifiers to the event, Segment create a new user profile.
25
+
When there are no pre-existing profiles that have matching identifiers to the event, Segment creates a new user profile.
26
26
27
27
**2: Add to existing profile**
28
28
When there is one profile that matches all identifiers in an event, Segment attempts to map the traits, identifiers and events on the call to that existing profile. If there is an excess of any identifier on the final profile, Segment defers to the Identity Resolution rules outlined below.
@@ -32,7 +32,7 @@ When there are multiple profiles that match the identifiers in an event, Segment
32
32
33
33
## Identity Resolution settings
34
34
35
-
Identity Admins should first configure Identity Resolution Settings page to protect the identity graph from inaccurate merges and user profiles.
35
+
Identity Admins should first configure Identity Resolution Settings to protect the identity graph from inaccurate merges and user profiles.
36
36
37
37
During the space creation process, the first step is to choose an Identity Resolution configuration. If this is your first space, you have the option to choose a Segment-suggested Out-of-the-Box configuration or a custom Identity Resolution setup. All other spaces have a third option of importing settings from a different space.
38
38
@@ -42,13 +42,13 @@ During the space creation process, the first step is to choose an Identity Resol
42
42
43
43
For most first-time Personas users, Segment recommends that you use the out-of-the-box configuration and answer a short series of questions for a best-fit setup for your use-case.
44
44
45
-
If you have custom unique identifiers or do not have a canonical `user_id` you are automatically redirected to the Identity Resolution Settings page to complete your setup.
45
+
If you have custom unique identifiers or do not have a canonical `user_id`, you are automatically redirected to the Identity Resolution Settings page to complete your setup.
46
46
47
47
### Custom rules
48
48
49
49
If you are familiar with identity or have custom identifiers, Segment recommends that you select Custom Rules.
50
50
51
-
Segment redirects you to the Identity Resolutions Settings page where you can add Default Identifiers or Custom Identifiers.
51
+
Segment redirects you to the Identity Resolution Settings page where you can add Default Identifiers or Custom Identifiers.
52
52
53
53
Segment's 11 default are:
54
54
@@ -72,7 +72,7 @@ You can also provide a trait or property key to match on to add custom identifie
72
72
73
73
#### Blocked values
74
74
75
-
Segment recommends that you proactively prevent using certain values as identifiers. While these values remain in the payload on the event itself, it is not promoted to as an identifier Segment uses to determine user profiles.
75
+
Segment recommends that you proactively prevent using certain values as identifiers. While these values remain in the payload on the event itself, it is not promoted to an identifier Segment uses to determine user profiles.
76
76
77
77
This is important when developers have a hard-coded value for fields like `user_id` during QA or development that then erroneously make it to production. This may cause hundreds of profiles to merge incorrectly and can have costly consequences if these spaces already feed data into a production email marketing tool or push notification tool downstream.
78
78
@@ -152,7 +152,7 @@ If a new android.id identifier appeared without first giving it explicit order,
152
152
| anonymous_id | 4 |
153
153
| ga_client_id | 5 |
154
154
155
-
If you require an explicit order for all identifiers, configure this in the Identity Resolution settings page before sending in events.
155
+
If you require an explicit order for all identifiers, configure this in the Identity Resolution Settings page before sending in events.
156
156
157
157
158
158
@@ -180,8 +180,8 @@ After you connect a source, Personas creates user profiles based off of replayed
180
180
181
181
182
182
183
-
The next step, which is important in the Dev space, is to create an audience to ensure that user profiles have populated correctly and that the identity resolution settings follow expected business logic.
183
+
The next step, which is important in the Dev space, is to create an audience to ensure that user profiles have populated correctly and that the Identity Resolution settings follow expected business logic.
184
184
185
-
For example, if there should be 100,000 distinct users who have a `user_id`, this would be a great way to validate that the identity resolution settings have calculated profiles correctly.
185
+
For example, if there should be 100,000 distinct users who have a `user_id`, this would be a great way to validate that the Identity Resolution settings have calculated profiles correctly.
186
186
187
187
For more information about how to create audiences and traits, see [Audiences](/docs/personas/audiences/).
0 commit comments