Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aptabase/aptabase-swift
Swift SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps
https://github.com/aptabase/aptabase-swift
analytics ios privacy privacy-first swift
Last synced: 2 months ago
JSON representation
Swift SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps
- Host: GitHub
- URL: https://github.com/aptabase/aptabase-swift
- Owner: aptabase
- License: mit
- Created: 2023-04-03T14:05:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-06T05:29:32.000Z (4 months ago)
- Last Synced: 2024-11-01T09:45:05.457Z (3 months ago)
- Topics: analytics, ios, privacy, privacy-first, swift
- Language: Swift
- Homepage: https://aptabase.com
- Size: 11.3 MB
- Stars: 23
- Watchers: 0
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Swift SDK for Aptabase
[](https://swiftpackageindex.com/aptabase/aptabase-swift)
[](https://swiftpackageindex.com/aptabase/aptabase-swift)
Instrument your apps with Aptabase, an Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps.
## Install
#### Option 1: Swift Package Manager
Add the following lines to your `Package.swift` file:
```swift
let package = Package(
...
dependencies: [
...
.package(name: "Aptabase", url: "https://github.com/aptabase/aptabase-swift.git", from: "0.3.4"),
],
targets: [
.target(
name: "MyApp",
dependencies: ["Aptabase"] // Add as a dependency
)
]
)
```
#### Option 2: Adding package dependencies with Xcode
Use this [guide](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app) to add `aptabase-swift` to your project. Use https://github.com/aptabase/aptabase-swift for the URL when Xcode asks.
#### Option 3: CocoaPods
Aptabase is also available through CocoaPods. To install it, simply add the following line to your Podfile:
```ruby
pod 'Aptabase', :git => 'https://github.com/aptabase/aptabase-swift.git', :tag => '0.3.4'
```
## Usage
> If you're targeting macOS, you must first enable the `Outgoing Connections (Client)` checkbox under the `App Sandbox` section.
First, you need to get your `App Key` from Aptabase, you can find it in the `Instructions` menu on the left side menu.
Initialized the SDK as early as possible in your app, for example:
```swift
import SwiftUI
import Aptabase
@main
struct ExampleApp: App {
init() {
Aptabase.shared.initialize(appKey: "") // 👈 this is where you enter your App Key
}
var body: some Scene {
WindowGroup {
MainView()
}
}
}
```
Afterward, you can start tracking events with `trackEvent`:
```swift
import Aptabase
Aptabase.shared.trackEvent("app_started") // An event with no properties
Aptabase.shared.trackEvent("screen_view", with: ["name": "Settings"]) // An event with a custom property
```
A few important notes:
1. The SDK will automatically enhance the event with some useful information, like the OS, the app version, and other things.
2. You're in control of what gets sent to Aptabase. This SDK does not automatically track any events, you need to call `trackEvent` manually.
- Because of this, it's generally recommended to at least track an event at startup
3. The `trackEvent` function is a non-blocking operation as it runs in the background.
4. Only strings and numbers values are allowed on custom properties
## Preparing for Submission to Apple App Store
When submitting your app to the Apple App Store, you'll need to fill out the `App Privacy` form. You can find all the answers on our [How to fill out the Apple App Privacy when using Aptabase](https://aptabase.com/docs/apple-app-privacy) guide.