Amplitude — Event streaming

Documentation Index

Fetch the complete documentation index at: https://docs.kameleoon.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Key benefits

• Precise behavior insights: The integration sends specific events to third-party tools for visitors exposed to web experiments and feature flags on SDK-based projects, such as apps. This detailed tracking enables a clearer view of how different variations impact user actions. For example, you can observe which variation drives more clicks, conversions, or other desired outcomes, helping you determine the most effective approach.
• Real-time decision-making: The integration provides data in real time, enabling on-the-fly decision-making. Armed with up-to-date insights into ongoing experiments, you can swiftly adjust strategies if a variation isn’t performing as expected.
• Effortless setup: Enable third-party integrations directly from the Kameleoon app with no need for custom code or SDK changes.

​

Considerations

• Event delivery timing: Kameleoon servers dispatch events with a minimum 30-minute delay.

​

Prerequisites

• Amplitude API key: The API key unique to one of your Amplitude projects (as documented here)
• Server residency: Specify whether your Amplitude account is configured for the standard hosting region or EU hosting.
• Amplitude plan: Select the type of customer plan you have purchased with Amplitude.

​

Set up

​

For web experiments

​

For feature experiments

• The Kameleoon visitor code (sent both as a custom property and the default value for the device_id field)
• Exposure timestamp
• Kameleoon experiment ID
• Kameleoon variation ID

​

Event payload example

{
    "event_type": "$identify",
    "user_properties":
    {
        "$set":
        {
            "KAM_EXPERIMENT_12345": "KAM_VARIATION_15685",
            "KAM_VISITOR_CODE": "rjfloel55ug9fg"
        }
    },
    "device_id": "rjfloel55ug9fg" // also Kameleoon visitor code
    "time": 1730194985000
}

​

Payload customization for user_id, device_id, and session_id

• Cross-device identification (user_id):
  • If you create a custom data and enable the option use for cross device identification, its value—when present during a visit—will be sent in the Amplitude user_id field. This custom data is ideal for “logged-in” identifiers associated with your users.
• Device identifier (device_id):
  • If you create a custom data called amplitude_device_id, its value—when present—will replace the Kameleoon visitor code in the device_id field of the payload. This custom data is recommended for “anonymous” identifiers tied to user devices. Regardless of whether this custom data is set, the original Kameleoon visitor code is still included in your payloads under the custom property KAMELEOON_VISITOR_CODE.
• Session identifier (session_id):
  • If you create a custom data called amplitude_session_id, its value—when present—will be sent in the Amplitude session_id field. We recommend setting this value to match the Amplitude session ID.

​

Event payload example

{
    "event_type": "$identify",
    "user_properties":
    {
        "$set":
        {
            "KAM_EXPERIMENT_12345": "KAM_VARIATION_15685",
            "KAM_VISITOR_CODE": "rjfloel55ug9fg"
        }
    },
    "device_id": "dfkslj47h9"
    "user_id": "xf54dd2thdd5",
    "session_id": 1396381378123
    "time": 1730194985000
}