+
diff --git a/guides/objective-c-setup.md b/guides/objective-c-setup.md
index 10538cf..3911731 100644
--- a/guides/objective-c-setup.md
+++ b/guides/objective-c-setup.md
@@ -10,7 +10,7 @@ tags:
featured: false
testedOn: Xcode 14.1 & Swift 5.5
description: Configure the TelemetryDeck SDK in Your Objective-C Application for iOS and macOS
-lead: Let's include the TelemetryClient Swift Package in your Objective-C application and send signals!
+lead: Let's include the TelemetryClient Swift Package in your Objective-C application and send events!
order: 1000
---
@@ -65,7 +65,6 @@ The `TelemetryClient` package will provide you with a class `TelemetryManager` t
return YES;
}
-
```
{% noteinfo "You need your app's Unique Identifier" %}
@@ -74,12 +73,35 @@ TelemetryDeck assigns a unique identifier to your app, and you need to hand that
Use the [TelemetryDeck Dashboard](https://dashboard.telemetrydeck.com) to create a new app and copy its unique identifier into your computer's clipboard.
{% endnoteinfo %}
-## Sending signals
+## Verify your setup
-Let's send a signal to show the app has launched correctly.
+Run your app to verify that TelemetryDeck is properly integrated. Let's send an event to show the app has launched correctly:
-{% noteinfo "What's a signal?" %}
+```objc
+[TelemetryManager send:@"applicationDidFinishLaunching"];
+```
+
+{% notewarning "When running from Xcode, you're sending test signals" %}
+If your app is built in `DEBUG` configuration (i.e. running from Xcode), your events will be tagged as **Test Signals**, meaning that you can easily filter them out later. You'll see them show up in the TelemetryDeck Dashboard when the **Test Mode** toggle under the tab bar is turned on.
+{% endnotewarning %}
+
+Open the TelemetryDeck Dashboard, navigate to "Explore > Recent Signals" and make sure "Test Mode" is enabled. You should see your signal appear after launching your app.
+
+---
+
+{% noteinfo "Ready for Basic Insights" %}
+Congratulations! With just the SDK initialization, TelemetryDeck will automatically track user sessions, app launches, and device information. This basic setup provides valuable built-in insights without any additional code.
+
+You can now build and ship your app. Once users start using it, your TelemetryDeck dashboard will begin showing data about user behavior, device types, and other key metrics.
+{% endnoteinfo %}
+
+## Enhancing your analytics (optional)
+
+While basic session tracking provides valuable information, sending custom events lets you answer questions specific to how users engage with *your* app.
+### Sending custom events
+
+{% noteinfo "What's a signal?" %}
Signals represent an **event** or a **view** that happened in your app, which is used by a **user**. Signals consist of these parts:
- **Signal Type**: A string that indicates which kind of event happened
@@ -88,17 +110,9 @@ Signals represent an **event** or a **view** that happened in your app, which is
See the [Signals Reference](/docs/api/signals-reference/) for more information about how you can effectively use Signals.
{% endnoteinfo %}
-See the [TelemetryDeck package's `README.md` file](https://github.com/TelemetryDeck/SwiftSDK/blob/main/README.md) for more information on how to send signals. For now, let's just send one signal that tells us the app has launched. Go to your app delegate and below the initialization add this line:
+You don't need to keep an instance of TelemetryManager and hand it around, just call the `send` function on the class directly. If you want to add custom metadata payload, add it to the function call as a dictionary:
```objc
-[TelemetryManager send:@"applicationDidFinishLaunching"];
-```
-
-We're done. This is all you need to send a signal. You don't need to keep an instance of TelemetryManager and hand it around, just call the `send` function on the class directly. If you want to add custom metadata payload, add it to the function call like as a dictionary.
-
-This is helpful for additional parameters for filtering or grouping signals. We'll auto add some metadata for you, like the app version, device model, etc.
-
-```swift
[
TelemetryManager
send:@"applicationDidFinishLaunching"
@@ -106,19 +120,37 @@ This is helpful for additional parameters for filtering or grouping signals. We'
];
```
-And you're done! You are now sending signals to the TelemetryDeck server (the signals are marked as **Testing Signals** in the dashboard, switch on **Testing Mode** to see them).
+The metadata is helpful for additional parameters for filtering or grouping signals. We'll automatically add some metadata for you, like the app version, device model, and more.
-{% notewarning "When running from Xcode, you're sending testing signals" %}
+For more information on how to send events, see the [TelemetryDeck package's `README.md` file](https://github.com/TelemetryDeck/SwiftSDK/blob/main/README.md).
-If you app is built in `DEBUG` configuration (that means running from Xcode), your signals will be tagged as **Testing Signals**, meaning that you can filter them out later. You'll see them show up in the TelemetryDeck Dashboard when it's set to **Test Mode**.
-{% endnotewarning %}
+## App Store requirements
+
+Before uploading your app to the App Store, you'll need to complete Apple's privacy details on App Store Connect. Although TelemetryDeck is privacy-focused, you still need to disclose analytics usage.
-## You're all set!
+For guidance on completing these requirements, see our [Apple App Privacy guide](/docs/articles/apple-app-privacy/).
-You can now send signals! Don't overdo it in the beginning. It's okay if you only send **one** signal, named `applicationDidFinishLaunching` in the beginning. This will already give you number of users, number of launches, retention⦠a lot!
+For privacy policy recommendations, check our [Privacy FAQ](/docs/guides/privacy-faq/#do-i-need-to-add-telemetrydeck-to-my-privacy-policy%3F).
-After a while, you can add a send call for each screen in your app, so you can see which screens are used most. We also recommend adding all your custom settings to your metadata each time (except the ones that might identify an individual user please). This way you can see which settings most of your users use.
+## What to do next
-## Privacy Policy and Opt-Out
+Now that you've integrated TelemetryDeck, learn how to use the analytics platform to gain valuable insights about your users:
-You don't need to update your privacy policy, [but we recommend you do it anyway](/docs/guides/privacy-faq/#do-i-need-to-add-telemetrydeck-to-my-privacy-policy%3F).
+
+
+
+
+
+
+
+ + + π Analytics Walkthrough +
+Learn how to navigate TelemetryDeck, interpret insights, and use analytics to make data-driven decisions that improve your app and grow your user base.
++ Start here to get real value from your analytics + β +
+
+
diff --git a/guides/privacy-faq.md b/guides/privacy-faq.md
index 339d92c..c85a295 100644
--- a/guides/privacy-faq.md
+++ b/guides/privacy-faq.md
@@ -38,7 +38,7 @@ Here's an example of how you could mention TelemetryDeck in your privacy policy:
## Do I need to fill out Apple's app privacy details?
-By default, the privacy manifest metadata included in the TelemetryDeck Swift SDK should already fill out Apple App Privacy Details information for you. See our [App Privacy Guide](/docs/articles/apple-app-privacy/) for more information.
+Yes, every app needs to fill out this form, even those that do not track any data. But our Swift SDK includes a privacy manifest which should list all the right things in your [generated privacy report](https://developer.apple.com/documentation/bundleresources/describing-data-use-in-privacy-manifests#Create-your-apps-privacy-report). Alternatively, see our [App Privacy Guide](/docs/articles/apple-app-privacy/) for detailed instructions.
## Do I need to offer an opt-out from TelemetryDeck?
@@ -56,7 +56,7 @@ See our article [How TelemetryDeck anonymizes user identifiers](/docs/articles/a
## What data does TelemetryDeck collect from my app users?
-By default, TelemetryDeck collects the following metadata from app users:
+By default, TelemetryDeck collects some metadata such as the following from app users:
- clientUser: The anonymized user identifier that you can use to identify a user
- type: The type of the signal, e.g. "event" or "error"
@@ -65,6 +65,8 @@ By default, TelemetryDeck collects the following metadata from app users:
- Device Information: architecture, locale, operating system version, device model, platform
- The SDK Version
+For a full list, refer to [this document](/docs/ingest/default-parameters/).
+
Developers can optionally send additional metadata with each signal.
### What data does TelemetryDeck collect from my website visitors?
diff --git a/guides/react-setup.md b/guides/react-setup.md
index c92631a..f131071 100644
--- a/guides/react-setup.md
+++ b/guides/react-setup.md
@@ -1,5 +1,5 @@
---
-title: React and React Native Setup Guide
+title: React (Native) Setup Guide
tags:
- Setup
- JavaScript
@@ -57,7 +57,7 @@ ReactDOM.render(
+
+
+
+
+
+
+ + + π Analytics Walkthrough +
+Learn how to navigate TelemetryDeck, interpret insights, and use analytics to make data-driven decisions that improve your app and grow your user base.
++ Start here to get real value from your analytics + β +
+
+
+
## Sponsors
[
+
+
+
+
+
+
+ + + π Analytics Walkthrough +
+Learn how to navigate TelemetryDeck, interpret insights, and use analytics to make data-driven decisions that improve your app and grow your user base.
++ Start here to get real value from your analytics + β +
+
](https://typedigital.de)
diff --git a/guides/swift-setup.md b/guides/swift-setup.md
index c519efe..cc3ef00 100644
--- a/guides/swift-setup.md
+++ b/guides/swift-setup.md
@@ -9,7 +9,7 @@ tags:
featured: true
testedOn: Xcode 16 & Swift 5.9
description: Configure the TelemetryDeck SDK in Your Swift Application for iOS, macOS, watchOS and tvOS
-lead: Let's include the TelemetryDeck Swift Package in your application and send signals!
+lead: Let's include the TelemetryDeck Swift Package in your application and send events!
order: 100
---
@@ -43,9 +43,9 @@ Xcode will ask you to link the package with your target in the next screen, titl
In case Xcode forgets to ask you to link the library with your target, you can do so manually by selecting your target in the project navigator and selecting the Build Phases tab. Click the + button in the Link Binary With Libraries section and select the `TelemetryDeck` library.
{% endnoteinfo %}
-## Initializing the TelemetryDeck Swift Package
+## Initializing the TelemetryDeck Swift package
-The `TelemetryDeck` package will provide you with a class `TelemetryDeck` that you'll use for all interactions with TelemetryDeck. Before you can use that class, you'll need to initialize it at the start of your app. We strongly recommend doing so as soon as possible, as you won't be able to send Signals before the `TelemetryDeck` is initialized.
+The `TelemetryDeck` package will provide you with a class `TelemetryDeck` that you'll use for all interactions with TelemetryDeck. Before you can use that class, you'll need to initialize it at the start of your app. We strongly recommend doing so as soon as possible, as you won't be able to send events before the `TelemetryDeck` is initialized.
This is slightly different depending on whether you use SwiftUI or UIKit's `AppDelegate` to manage your app's lifecycle, so let's look at these individually.
@@ -146,42 +146,55 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
}
```
-You are now ready to send signals!
+## Verify your setup
-## Sending signals
+Run your app to verify that TelemetryDeck is properly integrated. The SDK automatically sends a `TelemetryDeck.Session.started` signal when your app launches.
-Let's send a signal to show that something has happened in your app.
+{% notewarning "When running from Xcode, you're sending test events" %}
-{% noteinfo "What is a signal?" %}
+If your app is built in `DEBUG` configuration (i.e. running from Xcode), your events will be tagged as **Test Signals**, meaning that you can easily filter them out later. You'll see them show up in the TelemetryDeck Dashboard when the **Test Mode** toggle under the tab bar is turned on.
+{% endnotewarning %}
-Signals are an indication that **an event** happened in your app, which is used by a **user**. Signals consist of these parts:
+Open the TelemetryDeck Dashboard, navigate to "Explore > Recent Signals" and make sure "Test Mode" is enabled. You should see the automatic session signal appear after launching your app.
-- **Signal Name** βΒ A string that indicates which kind of event happened
-- **User Identifier** βΒ A string that identifies your user (we auto-generate one for you)
-- **Optional Parameters** β A dictionary of additional data about your app or the event triggering the signal
+---
-See the [Signals Reference](/docs/api/signals-reference/) for more information about how you can effectively use Signals.
+{% noteinfo "Ready for Basic Insights" %}
+Congratulations! With just the SDK initialization, TelemetryDeck will automatically track user sessions, app launches, and device information. This basic setup provides valuable built-in insights without any additional code.
+
+You can now build and ship your app. Once users start using it, your TelemetryDeck dashboard will begin showing data about user behavior, device types, and other key metrics.
{% endnoteinfo %}
-{% notewarning "When running from Xcode, you're sending test signals" %}
+## Enhancing your analytics (optional)
-If your app is built in `DEBUG` configuration (i.e. running from Xcode), your signals will be tagged as **Test Signals**, meaning that you can easily filter them out later. You'll see them show up in the TelemetryDeck Dashboard when the **Test Mode** toggle in the sidebar is turned on.
-{% endnotewarning %}
+While basic session tracking provides valuable information, sending custom events lets you answer questions specific to how users engage with *your* app.
+
+### Common questions you can answer with custom events
+
+- Which features do users engage with most frequently?
+- Where in the onboarding flow do users drop off?
+- How are users navigating between different screens?
+- Which settings or configurations are most popular?
+
+### Sending custom events
+
+{% noteinfo "What is a signal?" %}
+Signals are an indication that **an event** happened in your app, which is used by a **user**. Signals consist of these parts:
-The default way to set a user identifier is `TelemetryDeck.updateDefaultUserID`. This way you only have to set it once, or when it changes, such as user login.
-See the [TelemetryDeck SDK's `README.md` file](https://github.com/TelemetryDeck/SwiftSDK/blob/main/README.md) for more information on how to send signals.
+- **Signal Name** β A string that indicates which kind of event happened
+- **User Identifier** β A string that identifies your user (we auto-generate one for you)
+- **Optional Parameters** β A dictionary of additional data about your app or the event triggering the signal
-{% noteinfo "Best practice:" %}
-You can also set a user identifier per send call as shown below, but this is not usually necessary.
+See the [Signals Reference](/docs/api/signals-reference/) for more information about how you can effectively use Signals.
{% endnoteinfo %}
-Let's imaging your app is a pizza oven monitor and we want to send a signal that tells us the user has tapped the "Start Baking" button. Go to the place in your code where the user taps the button and add the following code:
+Let's imagine your app is a pizza oven monitor and we want to send a signal that tells us the user has tapped the "Start Baking" button. Go to the place in your code where the user taps the button and add the following code:
```swift
TelemetryDeck.signal("Oven.Bake.startBaking")
```
-And done. This is all you need to send a signal. You do not need to keep an instance of TelemetryDeck and hand it around, just call the static `signal` function on the class directly. If you want to add a custom parameters, add them to the function call like this:
+That's all you need to send a signal. You do not need to keep an instance of TelemetryDeck and hand it around, just call the static `signal` function on the class directly. If you want to add custom parameters, add them to the function call like this:
```swift
TelemetryDeck.signal(
@@ -197,11 +210,7 @@ TelemetryDeck.signal(
The value you pass to `customUserID` will be automatically hashed before being sent to our servers to protect the users privacy. This does not happen for the values in `parameters` though, so hash yourself where needed.
{% endnoteinfo %}
-And you're done! You are now sending signals to the TelemetryDeck server. π
-
-Run your app and confirm that your first signal arrived in the "Recent Signals" tab on TelemetryDeck. Don't forget to turn on "Test Mode" to see signals sent in debug builds!
-
-## Configuring Default Signal Properties (Optional)
+## Configuring default signal properties (optional)
When initializing TelemetryDeck, you can configure some defaults to help keep your signals organized and consistent:
@@ -224,20 +233,31 @@ config.defaultParameters = {[
// These parameters will be merged with any additional parameters you specify in signal() calls
```
-## Fill out Apple's app privacy details
-
-Something you need to do before you can upload your app to the App Store is going through Apple's privacy details on App Store Connect. This informs your users about what data is collected, and how it is collected.
-
-Although TelemetryDeck is privacy friendly, as we only handle not personally identifiable information, you still need to click through the privacy details.
-
-We have a [handy guide](/docs/articles/apple-app-privacy/) where we go over each step that is required.
-
-## Privacy Policy and Opt-Out
-
-You don't need to update your privacy policy, [but we recommend you do it anyway](/docs/guides/privacy-faq/#do-i-need-to-add-telemetrydeck-to-my-privacy-policy%3F).
-
-## You're all set!
-
-You can now send signals! Don't overdo it in the beginning. It's okay if you only send **one** signal, named `App.launched`. This will already give you number of users, number of launches, system versions, retention, and more!
-
-After a while, you can add a signal for each screen in your app, so you can see which screens your users use most. It's also recommended to add all your custom settings to your metadata each time. This way you can see which settings most of your users use.
+## App Store requirements
+
+Before uploading your app to the App Store, you'll need to complete Apple's privacy details on App Store Connect. Although TelemetryDeck is privacy-focused, you still need to disclose analytics usage.
+
+For guidance on completing these requirements, see our [Apple App Privacy guide](/docs/articles/apple-app-privacy/). For privacy policy recommendations, check our [Privacy FAQ](/docs/guides/privacy-faq/#do-i-need-to-add-telemetrydeck-to-my-privacy-policy%3F).
+
+## What to do next
+
+Now that you've integrated TelemetryDeck, learn how to use the analytics platform to gain valuable insights about your users:
+
+
+
diff --git a/guides/vue-setup.md b/guides/vue-setup.md
index 64290d1..6d58dc8 100644
--- a/guides/vue-setup.md
+++ b/guides/vue-setup.md
@@ -45,7 +45,7 @@ app.use(TelemetryDeckPlugin, {
app.mount("#app");
```
-## Basic Usage
+## Basic usage
```ts
+
+
+
+
+
+
+ + + π Analytics Walkthrough +
+Learn how to navigate TelemetryDeck, interpret insights, and use analytics to make data-driven decisions that improve your app and grow your user base.
++ Start here to get real value from your analytics + β +
+