• HOME
  • INTEGRATIONS
  • SDKS
  • GUIDES
  • API DOCS
No results for ""
EXPAND ALL
CLOSE
launchdarkly.com

EDIT ON GITHUB

Segment schema reference

Read time: 1 minute
Last edited: Mar 27, 2020

Overview

This topic explains the different event kinds for Segment Data Export destinations. The JSON schemas for Segment are formatted differently than LaunchDarkly's. The index, identify, and summary event types are not available in Segment data export destinations, and other events are exported with different labels.

To learn more about the Segment destination, read Segment's documentation.

There are four different event kinds Segment uses. They are:

  • Feature events: This event appears when a feature flag is evaluated.
  • Click events: This event appears when a user clicks on a CSS selector for which they have configured a metric in an experiment.
  • Page view events: This event appears when a user loads a page associated with an experiment metrics.
  • Custom events: The LaunchDarkly SDK sends a custom event.

Additional properties

Segment events include additional information about different LaunchDarkly properties. These properties are included in all event types. These properties are:

Property nameProperty details
eventThe event type.
environmentThe LaunchDarkly environment ID corresponding to event.
projectThe LaunchDarkly project ID corresponding to the event.
keyThe flag key corresponding to the event. In the case of experimentation events, this will be the metric key for the experiment.

Feature events

Property nameDescription
valueThe value of the evaluated flag.
flagVersionThe version of the evaluated flag.
reasonKindThe evaluation reason for the flag.
To learn more, read Evaluation reasons.
valueSet to another flag’s key if this flag evaluation was only performed in order to determine whether the prerequisite values were met for the indicated flag.
To learn more, read Flag prerequisites.
defaultIndicates whether the flag value was the result of the default variation being evaluated.
variationThe variation of the flag requested. Flag variation values are stored in an array. This value corresponds to the index of the variation the array. Boolean flags show as 0 or 1 for true and false, and other flag types are numbered starting with 0 for their different variations.
variationNameThe evaluated variation's name, if it exists. If the evaluated variation doesn't have a name, this field doesn't appear.

Click events

Property nameDescription
urlThe URL from which a user triggered a flag evaluation.
selectorThe CSS selector corresponding to the click event.

Page view events

Property nameDescription
urlThe URL from which a user triggered a flag evaluation.

Custom events

There are no properties for custom events other than the properties listed in Additional properties.