Skip to content

Commit 24898dc

Browse files
authored
fix mobile spec (#1060)
Reviewed and approved by: Irina
1 parent ced2485 commit 24898dc

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

src/connections/spec/mobile.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ The following events will be tracked automatically when lifecycle events are ena
5151

5252
This event fires when a user **first** opens your mobile application. Note, if the user never opens your app after installing, we will not be able to collect this event. This event does not wait for attribution or campaign information to be received, and is collected automatically by our SDKs. Advertising providers like Facebook and Google require discrete install events to correctly attribute installs to ads served through their platform.
5353

54-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event": "Application Installed", "properties": { "version": "1.2.3", "build": "1234" }}'}}} {% endcomment %}
54+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Application Installed", "properties": { "version": "1.2.3", "build": "1234" }}'}}} {% endcomment %}
5555

5656

5757
```json
5858
{
5959
"userId": "019mr8mf4r",
60-
"action": "track",
60+
"type": "track",
6161
"event": "Application Installed",
6262
"properties": {
6363
"version": "1.2.3", "build": "1234"
@@ -75,12 +75,12 @@ This event fires when a user **first** opens your mobile application. Note, if t
7575

7676
This event fires when a user launches or foregrounds your mobile application after the first open. It will fire after the `Application Installed` event and again after the app is re-opened after being closed. This event does not wait for attribution information to be received but may include information about referring applications or deep link URLs if available to the application upon open.
7777

78-
{% comment %} api-example '{"userId": "019mr8mf4r", "action": "track", "event": "Application Opened", "properties": { "from_background": false, "referring_application": "GMail", "url": "url://location" }}'}}} {% endcomment %}
78+
{% comment %} api-example '{"userId": "019mr8mf4r", "type": "track", "event": "Application Opened", "properties": { "from_background": false, "referring_application": "GMail", "url": "url://location" }}'}}} {% endcomment %}
7979

8080
```json
8181
{
8282
"userId": "019mr8mf4r",
83-
"action": "track",
83+
"type": "track",
8484
"event": "Application Opened",
8585
"properties": {
8686
"from_background": false,
@@ -103,12 +103,12 @@ This event fires when a user launches or foregrounds your mobile application aft
103103

104104
This event should be sent when a user backgrounds the application upon [`applicationDidEnterBackground`](https://developer.apple.com/reference/uikit/uiapplicationdelegate/1622997-applicationdidenterbackground)
105105

106-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event": "Application Backgrounded", "properties": {}}'}}} {% endcomment %}
106+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Application Backgrounded", "properties": {}}'}}} {% endcomment %}
107107

108108
```json
109109
{
110110
"userId": "019mr8mf4r",
111-
"action": "track",
111+
"type": "track",
112112
"event": "Application Backgrounded",
113113
"properties": {}
114114
}
@@ -118,12 +118,12 @@ This event should be sent when a user backgrounds the application upon [`applica
118118

119119
This event fires when a user updates the application. Our SDK will automatically collect this event in lieu of an "Application Opened" event when we determine that the Open is first since an update.
120120

121-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event": "Application Updated", "properties": { "previous_version": "1.1.2", "previous_build": 1234, "version": "1.2.0", "build": "1456" }}'}}} {% endcomment %}
121+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Application Updated", "properties": { "previous_version": "1.1.2", "previous_build": 1234, "version": "1.2.0", "build": "1456" }}'}}} {% endcomment %}
122122

123123
```json
124124
{
125125
"userId": "019mr8mf4r",
126-
"action": "track",
126+
"type": "track",
127127
"event": "Application Updated",
128128
"properties": {
129129
"previous_version": "1.1.2",
@@ -145,12 +145,12 @@ This event fires when a user updates the application. Our SDK will automatically
145145

146146
Fire this event when a user uninstalls the application. Several destination partners will detect this for you using Silent Push Notifications and send this event to Segment on your behalf.
147147

148-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event": "Application Uninstalled", "properties": {}}'}}} {% endcomment %}
148+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Application Uninstalled", "properties": {}}'}}} {% endcomment %}
149149

150150
```json
151151
{
152152
"userId": "019mr8mf4r",
153-
"action": "track",
153+
"type": "track",
154154
"event": "Application Uninstalled",
155155
"properties": {}
156156
}
@@ -160,12 +160,12 @@ Fire this event when a user uninstalls the application. Several destination part
160160

161161
You can send this event when you receive a crash notification from your app, but is not meant to supplant traditional crash reporting tools. By tracking crashes as an analytics event with device and user information, you can analyze the which types of users are impacted by crashes and how those crashes, in turn, affect their engagement. You may also want to target those customers with tailored communications in other channels if they've encountered several crashes.
162162

163-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event": "Application Crashed", "properties": {}}'}}} {% endcomment %}
163+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Application Crashed", "properties": {}}'}}} {% endcomment %}
164164

165165
```json
166166
{
167167
"userId": "019mr8mf4r",
168-
"action": "track",
168+
"type": "track",
169169
"event": "Application Crashed",
170170
"properties": {}
171171
}
@@ -179,12 +179,12 @@ As the walls between apps become increasingly lowered, capturing information abo
179179

180180
When Segment or an integrated partner can discern the source of an install, we'll collect an `Install Attributed` event. This event may be sent to Segment using server-to-server connection from your attribution provider, or directly on the device using packaged destinations. In either case, this will happen **after** install, and does not apply to all installs, which is why it is a discrete event.
181181

182-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event": "Install Attributed", "properties": { "provider": "Tune/Kochava/Branch/AppsFlyer", "campaign": { "source": "Network/FB/AdWords/MoPub/Source", "name": "Campaign Name", "content": "Organic Content Title", "ad_creative": "Red Hello World Ad", "ad_group": "Red Ones" }}}'}}} {% endcomment %}
182+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Install Attributed", "properties": { "provider": "Tune/Kochava/Branch/AppsFlyer", "campaign": { "source": "Network/FB/AdWords/MoPub/Source", "name": "Campaign Name", "content": "Organic Content Title", "ad_creative": "Red Hello World Ad", "ad_group": "Red Ones" }}}'}}} {% endcomment %}
183183

184184
```json
185185
{
186186
"userId": "019mr8mf4r",
187-
"action": "track",
187+
"type": "track",
188188
"event": "Install Attributed",
189189
"properties": {
190190
"provider": "Tune/Kochava/Branch/AppsFlyer",
@@ -214,12 +214,12 @@ When Segment or an integrated partner can discern the source of an install, we'l
214214

215215
This event can be sent when a push notification is received in the app. It can be automatically enabled on [iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#automatic-push-notification-tracking).
216216

217-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event": "Push Notification Received", "properties": { "campaign": { "medium": "Push", "source": "Vendor Name", "name": "Referral Flow", "content": "Your friend invited you to play a match."}}}'}}} {% endcomment %}
217+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Push Notification Received", "properties": { "campaign": { "medium": "Push", "source": "Vendor Name", "name": "Referral Flow", "content": "Your friend invited you to play a match."}}}'}}} {% endcomment %}
218218

219219
```json
220220
{
221221
"userId": "019mr8mf4r",
222-
"action": "track",
222+
"type": "track",
223223
"event": "Push Notification Received",
224224
"properties": {
225225
"campaign": {
@@ -244,12 +244,12 @@ This event can be sent when a push notification is received in the app. It can b
244244

245245
This event can be sent when a user taps on a push notification associated with your app. It can be automatically enabled on [iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#automatic-push-notification-tracking).
246246

247-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event": "Push Notification Tapped", "properties": {"action": "Accept", "campaign": { "medium": "Push", "source": "Vendor Name", "name": "Referral Flow", "content": "Your friend invited you to play a match." }}}'}}} {% endcomment %}
247+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Push Notification Tapped", "properties": {"action": "Accept", "campaign": { "medium": "Push", "source": "Vendor Name", "name": "Referral Flow", "content": "Your friend invited you to play a match." }}}'}}} {% endcomment %}
248248

249249
```json
250250
{
251251
"userId": "019mr8mf4r",
252-
"action": "track",
252+
"type": "track",
253253
"event": "Push Notification Tapped",
254254
"properties": {
255255
"action": "Accept",
@@ -277,12 +277,12 @@ This event can be sent when a user taps on a push notification associated with y
277277

278278
This event fires when a push notification from a provider bounces. If your push notification provider forwards push lifecycle events to Segment, they should include this event in their suite.
279279

280-
{% comment %} api-example '{ "userId": "019mr8mf4r", "action": "track", "event":"Push Notification Bounced", "properties": { "action": "Accept", "campaign": { "medium": "Push", "source": "Vendor Name", "name": "Referral Flow", "content": "Your friend invited you to play a match." }}}'}}} {% endcomment %}
280+
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event":"Push Notification Bounced", "properties": { "action": "Accept", "campaign": { "medium": "Push", "source": "Vendor Name", "name": "Referral Flow", "content": "Your friend invited you to play a match." }}}'}}} {% endcomment %}
281281

282282
```json
283283
{
284284
"userId": "019mr8mf4r",
285-
"action": "track",
285+
"type": "track",
286286
"event":"Push Notification Bounced",
287287
"properties": {
288288
"action": "Accept",
@@ -313,12 +313,12 @@ This event is fired *in addition* to the associated `Application Opened` event.
313313

314314
Our [iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#automatic-deep-link-tracking) SDK can collect this event automatically if configured to do so.
315315

316-
{% comment %} api-example '{"userId": "019mr8mf4r", "action": "track", "event": "Deep Link Opened", "properties": {"provider": "Branch Metrics", "url": "app://landing" }}'}}} {% endcomment %}
316+
{% comment %} api-example '{"userId": "019mr8mf4r", "type": "track", "event": "Deep Link Opened", "properties": {"provider": "Branch Metrics", "url": "app://landing" }}'}}} {% endcomment %}
317317

318318
```json
319319
{
320320
"userId": "019mr8mf4r",
321-
"action": "track",
321+
"type": "track",
322322
"event": "Deep Link Opened",
323323
"properties": {
324324
"provider": "Branch Metrics",
@@ -337,12 +337,12 @@ Our [iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#automatic-deep
337337

338338
This event may be provided by deep link providers postback mechanisms or an internal redirect service if you use one in order to provide a waypoint funnel step between your content or advertisement and the resulting app open.
339339

340-
{% comment %} api-example '{"userId": "019mr8mf4r", "action": "track", "event": "Deep Link Clicked", "properties": {"provider": "Branch Metrics", "url": "brnch.io/1234"}}'}}} {% endcomment %}
340+
{% comment %} api-example '{"userId": "019mr8mf4r", "type": "track", "event": "Deep Link Clicked", "properties": {"provider": "Branch Metrics", "url": "brnch.io/1234"}}'}}} {% endcomment %}
341341

342342
```json
343343
{
344344
"userId": "019mr8mf4r",
345-
"action": "track",
345+
"type": "track",
346346
"event": "Deep Link Clicked",
347347
"properties": {
348348
"provider": "Branch Metrics",

0 commit comments

Comments
 (0)