You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Using the [Destination Filters API](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5){:target="_blank"}, you can create a rule to randomly sample video heartbeat events.
96
97
97
-
### Drop Events
98
+
### Drop events
98
99
99
100
[Watch this Destination Filters walkthrough](https://www.youtube.com/watch?v=47dhAF1Hoco){:target="_blank"} to learn how to use event names to filter events sent to destinations.
Copy file name to clipboardExpand all lines: src/connections/functions/destination-functions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -452,7 +452,7 @@ Yes, Functions access is logged in the [Audit Trail](/docs/segment-app/iam/audit
452
452
453
453
##### Does Segment retry failed function invocations?
454
454
455
-
Segment retries 9 times over the course of 4 hours. This increases the number of attempts for messages, so Segment tries to re-deliver them another 4 times after some backoff. Segment doesn't retry if your function throws a [non-recoverable error](#errors-and-error-handling).
455
+
Segment retries invocations that throw RetryError or Timeout errors for up to four hours. Segment does not retry if your function throws a [non-recoverable error](#errors-and-error-handling).
456
456
457
457
##### Are events guaranteed to send data in order?
Copy file name to clipboardExpand all lines: src/connections/functions/source-functions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -385,7 +385,7 @@ Copy and paste this URL into the upstream tool or service to send data to this s
385
385
386
386
##### What is the retry policy for a webhook payload?
387
387
388
-
The webhook payload retries up to six times with an exponential backoff for the function in the event of a failure with the function. After six attempts, the message is dropped.
388
+
Segment retries invocations that throw RetryError or Timeout errors up to six times. After six attempts, the request is dropped.
389
389
390
390
##### What is the maximum payload size for the incoming webhook?
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/cloud-apps/braze/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Braze maintains this source. For any issues with the source, you can [contact th
23
23
The nickname is used as a label for the source in your Segment interface, and Segment creates a related schema name. The schema name is the namespace you'll query against in a warehouse. The nickname can be anything, but Segment recommends sticking to something that reflects the source itself and distinguishes amongst your environments (for example, `Braze_Prod`, `Braze_Staging`, `Braze_Dev`).
24
24
4. Copy the **Write Key** on the Overview page.
25
25
5. To finish the setup, contact Braze Support or your Customer Support Manager to activate Currents in Braze.
26
-
Braze Currents is only available in select Braze packages and can't be configured within Braze without assistance from your Braze Customer Success representative.
26
+
-**Note:**Braze Currents is only available in select Braze packages and can't be configured within Braze without assistance from your Braze Customer Success representative. Select the appropriate **Supported Region** in the Braze Currents configuration if you are using a non U.S. Segment Region.
27
27
6. Go back to Segment and click **Add Destinations** in your Braze source to add the destinations where you want to receive your Braze data.
28
28
29
29
Events are now sent to these destinations and automatically loaded into any warehouses you enabled.
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ With Analytics-Kotlin, you can send data using Kotlin applications to any analyt
16
16
If you're migrating to Analytics-Kotlin from a different mobile library, you can skip to the [migration guide](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/migration/).
17
17
18
18
19
-
## Getting Started
19
+
## Getting started
20
20
21
21
To get started with the Analytics-Kotlin mobile library:
22
22
@@ -92,7 +92,9 @@ To get started with the Analytics-Kotlin mobile library:
92
92
93
93
The SDK internally uses a number of Java 8 language APIs through desugaring. Make sure your project either [enables desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring)) or requires a minimum API level of 26.
94
94
95
-
## Tracking Methods
95
+
You'll find configuration options such as IDFA collection and automatic screen tracking in Segment’s [Plugin Examples repository](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins){:target="_blank"}.
96
+
97
+
## Tracking methods
96
98
97
99
Once you've installed the mobile or server Analytics-Kotlin library, you can start collecting data through Segment's tracking methods:
The [Screen](/docs/connections/spec/screen/) method lets you record whenever a user sees a screen in your mobile app, along with optional extra information about the page being viewed.
155
157
156
-
You'll want to record a screen event whenever the user opens a screen in your app. This could be a view, fragment, dialog or activity depending on your app.
158
+
You'll want to record a screen event whenever the user opens a screen in your app. This could be a view, fragment, dialog, or activity depending on your app.
157
159
158
160
Not all integrations support screen, so when it's not supported explicitly, the screen method tracks as an event with the same parameters.
Segment's plugin architecture enables you to modify and augment how the analytics client works. From modifying event payloads to changing analytics functionality, plugins help to speed up the process of getting things done.
208
210
209
-
Plugins are run through a timeline, which executes in order of insertion based on their entry types. Segment has these 5 entry types:
211
+
Plugins are run through a timeline, which executes in order of insertion based on their entry types. Segment has these five entry types:
@@ -217,7 +219,7 @@ Plugins are run through a timeline, which executes in order of insertion based o
217
219
|`utility`| Executes only with manual calls such as Logging. |
218
220
219
221
### Fundamentals
220
-
There are 3 basic types of plugins that you can use as a foundation for modifying functionality. They are: [`Plugin`](#plugin), [`EventPlugin`](#eventplugin), and [`DestinationPlugin`](#destinationplugin).
222
+
There are three basic types of plugins that you can use as a foundation for modifying functionality. They are: [`Plugin`](#plugin), [`EventPlugin`](#eventplugin), and [`DestinationPlugin`](#destinationplugin).
221
223
222
224
#### Plugin
223
225
`Plugin` acts on any event payload going through the timeline.
@@ -341,7 +343,7 @@ analytics.add(yourPlugin)
341
343
See how different platforms and languages use Analytics-Kotlin in different [example projects](https://github.com/segmentio/analytics-kotlin/tree/main/samples).
342
344
The example projects contain sample [plugins](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins) and [destination plugins](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins) you can utilize.
343
345
344
-
## Utility Methods
346
+
## Utility methods
345
347
The Analytics-Kotlin utility methods help you work with plugins from the analytics timeline. They include:
346
348
-[Add](#add)
347
349
-[Find](#find)
@@ -440,7 +442,7 @@ analytics.reset()
440
442
{% endcodeexampletab %}
441
443
{% endcodeexample %}
442
444
443
-
## Build Your Own Destination
445
+
## Build Your own destination
444
446
445
447
If Segment doesn't support your Kotlin destination, you can build your own with the template Segment provides.
// Override point for customization after application launch.
40
40
let configuration =Configuration(writeKey: "WRITE_KEY")
@@ -68,6 +68,7 @@ Once you've installed the Analytics-Swift library, you can start collecting data
68
68
- [Track](#track)
69
69
- [Screen](#screen)
70
70
- [Group](#group)
71
+
- [Alias](#alias)
71
72
72
73
### Identify
73
74
The [Identify](/docs/connections/spec/identify/) method lets you tie a user to their actions and record traits about them. This includes a unique user ID and anyoptional traits you know about them like their email, name, address. The traits option can include any information you want to tie to the user. When using anyof the reserved traits, be sure the information reflects the name of the trait. For example, `email` should always be a string of the user's email address.
The [Alias](/docs/connections/spec/alias/) method is used to merge two user identities, effectively connecting two sets of user data as one. When this method is called, the `newId` value overwrites the old `userId`. If no `userId` is currently set, the `newId` associates with future events as the `userId`. This is an advanced method and may not be supported across the entire destination catalog.
192
+
193
+
{% codeexample %}
194
+
{% codeexampletab Method signature %}
195
+
```swift
196
+
funcalias(newId: String)
197
+
```
198
+
{% endcodeexampletab %}
199
+
200
+
{% codeexampletab Example use %}
201
+
```swift
202
+
analytics.alias(newId: "user-123")
203
+
```
204
+
{% endcodeexampletab %}
205
+
{% endcodeexample %}
206
+
189
207
## Plugin Architecture
190
208
Segment's plugin architecture enables you to modify and augment how the analytics client works. From modifying event payloads to changing analytics functionality, plugins help to speed up the process of getting things done.
0 commit comments