No results for ""
EXPAND ALL
  • Home
  • API docs

GIVE DOCS FEEDBACK

mParticle schema reference

Read time: 4 minutes
Last edited: Aug 21, 2023

Overview

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

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

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

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

Feature events

This table lists feature events:

DescriptionEvent details
event_type: custom_event

custom_event_type “other”

event_name: Feature
Describes a feature flag evaluation which occurred in a LaunchDarkly SDK event_type: “custom” for this event.

Custom attributes

This table lists custom attributes:

DescriptionAttribute event details
projectID of the LaunchDarkly project associated with the event.
environmentID of the LaunchDarkly environment associated with the event.
versionThe version of event schema.
flag_versionThe version number of the flag when it was evaluated.
valueThe value of the feature flag returned by feature flag evaluation.
keyThe key of the flag requested.
defaultWhether the flag evaluation was a result of the default value being used. Is set to true if feature flag evaluation failed, if omitted assumed to be false.
reason_kindIf a feature event was generated through a "variation detail" method, the event will have a reason property with the JSON representation of the evaluation reason.
prerequisite_ofSet 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.
variation_nameThe evaluated variation's name, if it exists. If the evaluated variation doesn't have a name, this field doesn't appear.

Click events

This table lists click events:

DescriptionEvent details
event_type: custom_event

custom_event_type “navigation”

event_name: Click
Describes an event generated by the LaunchDarkly SDK when an end user clicks on a designated HTML element event_type: “custom” for this event.

Custom attributes

This table lists custom attributes:

DescriptionAttribute event details
projectID of the LaunchDarkly project associated with the event.
environmentID of the LaunchDarkly environment associated with the event.
versionThe version of event schema.
keyThe key of the feature flag requested.
urlThe URL of the page the end user was on when the click occurred.
selectorThe CSS selector that was clicked.

Page view events

This table lists page view events:

DescriptionEvent details
event_type: screen_view

custom_event_type: other

event_name: Page view
Describes an event generated by a LaunchDarkly SDK when an end user views an action changes the browser’s URL event_type: “screen_view” for this event.
screen_nameURL stripped of query string.

Custom attributes

This table lists custom attributes:

DescriptionAttribute event details
projectID of the LaunchDarkly project associated with the event.
environmentID of the LaunchDarkly environment associated with the event.
versionThe version of event schema.
keyThe key of the feature flag requested.
urlThe URL of the page the end user was on when the page view occurred.

Custom events

This table lists custom events:

DescriptionEvent details
event_type: custom_event

custom_event_type “other”

event_name: Custom
Describes an event generated by a LaunchDarkly SDK in response to an end user calling the SDK’s "track" function event_type: "custom" for this event.

Custom attributes

This table lists custom attributes:

DescriptionAttribute event details
projectID of the LaunchDarkly project associated with the event.
environmentID of the LaunchDarkly environment associated with the event.
versionThe version of event schema.
keyThe key of the metric  associated with the custom event.
metric_valueThe numeric value of a metric if it is specified in the event. If no metric value was provided, this field doesn't appear.