Skip to content

Predictions and Mobile batch edits [DOC-1250][DOC-1251] #7897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 9, 2025
Merged

Predictions and Mobile batch edits [DOC-1250][DOC-1251] #7897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a944ae1
initial edits to mobile and predictions
rchinn1 Sep 5, 2025
137f518
Predictions-edits
rchinn1 Sep 5, 2025
d215832
formatting fix
rchinn1 Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions src/connections/spec/mobile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ One of the core components of the Segment [Spec](/docs/connections/spec/) is the
By standardizing the events that comprise the core **mobile application lifecycle** and associated **mobile campaign and referral events**, Segment and its partners can, wherever possible, forward these events on your behalf and build downstream destinations that take full advantage of the semantic meaning associated with these events and their properties.

> info ""
> If you're already collecting similar events, Segment recommends migrating to these event names so that you can take advantage of available features in Segment destinations that depend on the spec as they become available.
> If you're already collecting similar events, Segment recommends migrating to these event names so that you can take advantage of available features in Segment destinations that depend on the spec as they become available.

These events pair nicely with Segment's [ecommerce spec](/docs/connections/spec/ecommerce/v2/) for mobile marketplaces to take full advantage of features like dynamic ads in Facebook and the ability to take full advantage of server-side destinations with Mobile Attribution Platforms like [Tune](https://www.tune.com/){:target="_blank"} and [Kochava](https://www.kochava.com/){:target="_blank"}.
These events also work with Segment's [ecommerce spec](/docs/connections/spec/ecommerce/v2/) for mobile marketplaces to take full advantage of features like dynamic ads in Facebook and the ability to take full advantage of server-side destinations with Mobile Attribution Platforms like [Tune](https://www.tune.com/){:target="_blank"} and [Kochava](https://www.kochava.com/){:target="_blank"}.

> info ""
> Per the [Privacy Policy](https://segment.com/legal/privacy/#sensitive-personal-information){:target="_blank"} and applicable terms, don't send Segment sensitive personal information about your users. Certain features from Segment and its partners allow you to opt-in to automatically track data (for example: Application Installed or Deep Link Clicked). When working with these features and Segment in general, be cognizant of the data that is being tracked to ensure its matching both your obligations under your agreement with Segment and the privacy expectations of your users.
> Per the [Privacy Policy](https://segment.com/legal/privacy/#sensitive-personal-information){:target="_blank"} and applicable terms, don't send Segment sensitive personal information about your users. Certain features from Segment and its partners allow you to opt-in to automatically track data (for example, **Application Installed** or **Deep Link Clicked**). When working with these features and Segment in general, be cognizant of the data that is being tracked to ensure its matching both your obligations under your agreement with Segment and the privacy expectations of your users.

## Overview of events

Expand All @@ -37,7 +37,7 @@ The Segment Native Mobile Spec includes the following semantic events:
- [Deep Link Opened](#deep-link-opened)
- [Deep Link Clicked](#deep-link-clicked)

Segment recommends using the above event names if you're going to be integrating the events yourself. This will ensure that they can be mapped effectively in downstream tools.
We recommend using the above event names if you're going to be integrating the events yourself. This will ensure that they can be mapped effectively in downstream tools.

## Lifecycle events

Expand Down Expand Up @@ -80,7 +80,7 @@ This event fires when a user **first** opens your mobile application. Note, if t
}
```

| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ------------ | -------- | -------------------------------------- |
| `version` | String | The version installed. |
| `build` | String | The build number of the installed app. |
Expand All @@ -105,7 +105,7 @@ This event fires when a user launches or foregrounds your mobile application aft
}
```

| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `from_background` | Boolean | If application [transitioned](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/doc/uid/TP40006786-CH3-SW52){:target="_blank"} from "Background" to "Inactive" state prior to foregrounding (as opposed to from "Not Running" state). |
| `url` | String | The value of `UIApplicationLaunchOptionsURLKey` from `launchOptions`. **Collected on iOS only**. |
Expand Down Expand Up @@ -164,7 +164,7 @@ This event fires when a user updates the application. Segment's SDK will automat
}
```

| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ------------------ | -------- | -------------------------------- |
| `previous_version` | String | The previously recorded version. |
| `previous_build` | String | The previously recorded build. |
Expand Down Expand Up @@ -231,7 +231,7 @@ When Segment or an integrated partner can discern the source of an install, we'l
}
```

| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ----------------------- | -------- | --------------------------------------- |
| `provider` | String | The attribution provider. |
| `campaign[source]` | String | Campaign source — attributed ad network.|
Expand Down Expand Up @@ -264,7 +264,7 @@ This event can be sent when a push notification is received in the app. It can b
}
```

| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ------------------- | -------- | ---------------------------------------------------------- |
| `campaign[name]` | String | Campaign name. |
| `campaign[medium]` | String | Identifies what type of link was used (Push Notification). |
Expand Down Expand Up @@ -296,7 +296,7 @@ This event can be sent when a user taps on a push notification associated with y
```


| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ------------------- | -------- | ----------------------------------------------------------------------------------- |
| `action` | String | If this notification is "actionable", the custom action tapped. **Default:** "Open" |
| `campaign[name]` | String | Campaign name. |
Expand Down Expand Up @@ -328,7 +328,7 @@ This event fires when a push notification from a provider bounces. If your push
}
```

| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ------------------- | -------- | ----------------------------------------------------------------------------------- |
| `action` | String | If this notification is "actionable", the custom action tapped. **Default:** "Open" |
| `campaign[name]` | String | Campaign name. |
Expand Down Expand Up @@ -357,7 +357,7 @@ This event is fired *in addition* to the associated `Application Opened` event.
}
```

| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ------------ | -------- | ----------------------- |
| `provider` | String | The deep link provider. |
| `url` | String | The App URL opened. |
Expand All @@ -381,7 +381,7 @@ This event may be provided by deep link providers postback mechanisms or an inte
}
```

| **Property** | **Type** | **Description** |
| Property | Type | Description |
| ------------ | -------- | -------------------------- |
| `provider` | String | The deep link provider. |
| `url` | String | The deep link URL clicked. |
6 changes: 3 additions & 3 deletions src/unify/Traits/predictions/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ For example, to predict a customer's propensity to purchase over the next 30 day

To access Predictions, you must:

- Track more than 1 event type, but fewer than 2,000 event types. An event type refers to the total number of distinct events seen across all users in an Engage Space within the past 15 days.
- Track more than one event type, but fewer than 2,000 event types. An event type refers to the total number of distinct events seen across all users in an Engage Space within the past 15 days.
- If you currently track more than 2,000 distinct events, reduce the number of tracked events below this limit and wait around 15 days before creating your first prediction.
- Events become inactive if they've not been sent to an Engage Space within the past 15 days.
- To prevent events from reaching your Engage Space, modify your event payloads to set `integrations.Personas` to `false`.
Expand Down Expand Up @@ -113,7 +113,7 @@ If you don’t track `Order Completed`, choose a target event that represents a

### Predicted Lifetime Value

Predicted Lifetime Value predicts a customer's future spend over the next 120 days. To create this prediction, select a purchase event, revenue property, and the currency (which defaults to USD). LTV is only calculated for customers that have performed the selected purchase events 2 or more times. The following table contains details for each property:
Predicted Lifetime Value predicts a customer's future spend over the next 120 days. To create this prediction, select a purchase event, revenue property, and the currency (which defaults to USD). LTV is only calculated for customers that have performed the selected purchase events two or more times. The following table contains details for each property:

| Property | Description |
| --------------- | -------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -150,7 +150,7 @@ Once a trait successfully computes, you can send them downstream to some destina
BRAZE = "braze_id"
SEGMENT = "segment_id"

Other destinations may drop events published by Predictive Traits
Other destinations may drop events published by Predictive Traits.

For use additional cases and information on how Segment builds prediction, read [Using Predictions](/docs/unify/traits/predictions/using-predictions/).

Expand Down
Loading