Skip to content

Commit f2bfff9

Browse files
author
markzegarelli
authored
Merge pull request #1767 from segmentio/kameleoon
added docs for kameleoon integration
2 parents 311708d + cac9da7 commit f2bfff9

File tree

2 files changed

+85
-3
lines changed

2 files changed

+85
-3
lines changed
Lines changed: 84 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,86 @@
11
---
2-
title: 'Kameleoon Destination'
3-
hidden: true
4-
beta: true
2+
title: Kameleoon Destination
3+
rewrite: true
54
---
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.
7+
8+
This destination is maintained by Kameleoon. For any issues with the destination, [contact the Kameleoon Support team](mailto:[email protected]).
9+
10+
11+
## Getting Started
12+
13+
{% include content/connection-modes.md %}
14+
15+
Segment’s Kameleoon destination supports the following Kameleoon products:
16+
* [Kameleoon Experiment](https://www.kameleoon.com/en/platform/ab-testing-client-side){:target="_blank"} (Web Client-side)
17+
* [Kameleoon Full Stack](https://www.kameleoon.com/en/platform/ab-testing-full-stack){:target="_blank"} (Web or mobile Apps, IoT..)
18+
* [Kameleoon AI Personalization](https://www.kameleoon.com/en/platform/personalization){:target="_blank"} (Web Client-side)
19+
20+
21+
To begin, request a Kameleoon API key from [[email protected]](mailto:[email protected]).
22+
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+
25+
To add the destination to your Segment workspace:
26+
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.
30+
4. Enter the **API Key** and the **sitecode** in the Kameleoon destination settings in Segment.
31+
32+
## Implementation pre-requisites: matching Users between Kameleoon and Segment
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.
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.
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"}.
39+
40+
If you use Kameleoon Full Stack, please refer to the [Kameleoon SDK documentation](https://developers.kameleoon.com/sdks-overview.html){:target="_blank"}.
41+
42+
43+
## Supported methods
44+
45+
Kameleoon supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
46+
47+
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://https://help.kameleoon.com/set-up-goal-campaign/){:target="_blank"}.
48+
49+
### Page
50+
51+
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.
52+
53+
For example:
54+
55+
```js
56+
analytics.page('Home', {"k_visitorCode": "oa16i4syt2ve3b0z"});
57+
```
58+
59+
60+
### Screen
61+
62+
Send [Screen](/docs/connections/spec/screen/) calls to record whenever a user sees a screen, the mobile equivalent of page, in your mobile app, along with any properties about the screen. Calling page or screen in a source is one of the first steps to getting started with Segment.
63+
64+
For example:
65+
66+
```obj-c
67+
[[SEGAnalytics sharedAnalytics] screen:@"Home"
68+
properties:@{ @"k_visitorCode": @"oa16i4syt2ve3b0z" }];
69+
```
70+
71+
Segment sends Screen calls to Kameleoon as a `screenview`.
72+
73+
74+
### Track
75+
76+
Send [Track](/docs/connections/spec/track/) calls to record any actions your users perform, along with any properties that describe the action.
77+
78+
For example:
79+
80+
```js
81+
analytics.track('Login Button Clicked', {"k_visitorCode": "oa16i4syt2ve3b0z"});
82+
```
83+
84+
Segment sends Track calls to Kameleoon as a `track` event.
85+
86+

vale-styles/Vocab/Docs/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ https
1212
Javadoc
1313
Javadocs
1414
Javascript
15+
Kameleoon
1516
Kissmetrics
1617
Littledata
1718
Middleware

0 commit comments

Comments
 (0)