mParticle schema reference
Read time: 4 minutes
Last edited: Oct 30, 2024
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 acustom
event.
Feature events
This table lists feature
events:
Description | Event 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:
Description | Attribute event details |
---|---|
project | ID of the LaunchDarkly project associated with the event. |
environment | The LaunchDarkly environment ID, also called the client-side ID, associated with the event. |
version | The version of event schema. |
flag_version | The version number of the flag when it was evaluated. |
value | The value of the feature flag returned by feature flag evaluation. |
key | The key of the flag requested. |
default | Whether 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_kind | If 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_of | Set 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_name | The 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:
Description | Event 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:
Description | Attribute event details |
---|---|
project | ID of the LaunchDarkly project associated with the event. |
environment | The LaunchDarkly environment ID, also called the client-side ID, associated with the event. |
version | The version of event schema. |
key | The key of the feature flag requested. |
url | The URL of the page the end user was on when the click occurred. |
selector | The CSS selector that was clicked. |
Page view events
This table lists page view
events:
Description | Event 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_name | URL stripped of query string. |
Custom attributes
This table lists custom attributes:
Description | Attribute event details |
---|---|
project | ID of the LaunchDarkly project associated with the event. |
environment | The LaunchDarkly environment ID, also called the client-side ID, associated with the event. |
version | The version of event schema. |
key | The key of the feature flag requested. |
url | The URL of the page the end user was on when the page view occurred. |
Custom events
This table lists custom
events:
Description | Event 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:
Description | Attribute event details |
---|---|
project | ID of the LaunchDarkly project associated with the event. |
environment | The LaunchDarkly environment ID, also called the client-side ID, associated with the event. |
version | The version of event schema. |
key | The key of the metric associated with the custom event. |
metric_value | The numeric value of a metric if it is specified in the event. If no metric value was provided, this field doesn't appear. |