Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaoscoder/beekeeper
An anonymous usage statistics tracking library for iOS using a differential privacy approach.
https://github.com/chaoscoder/beekeeper
Last synced: 8 days ago
JSON representation
An anonymous usage statistics tracking library for iOS using a differential privacy approach.
- Host: GitHub
- URL: https://github.com/chaoscoder/beekeeper
- Owner: ChaosCoder
- License: mit
- Created: 2018-04-18T17:39:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-28T13:10:17.000Z (10 months ago)
- Last Synced: 2024-04-29T07:00:30.132Z (7 months ago)
- Language: Swift
- Homepage:
- Size: 527 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[]() []() [](LICENSE.md) [](https://app.bitrise.io/app/de6c8de2d3e47847)
# Beekeeper
An anonymous usage statistics tracking library for iOS using a [differential privacy](https://en.wikipedia.org/wiki/Differential_privacy) approach.
Beekeeper allows you to get insights about your most important KPIs like daily, weekly or monthly active users, funnels and events and much more without sacrificing your users' privacy.
## Install
### Swift Package Manager
```swift
.package(url: "https://github.com/ChaosCoder/Beekeeper.git", from: "1.0.0")
```
## What user data is stored?
An event in the app (*e.g. user tapped a button or opened the app) is sent via Beekeeper to your server.
An event, that is fired in your app, includes the following data:
- `id: String`: Random UUID for the event
- `product: String`: The app the event was fired in
- `timestamp: Date`: The precise timestamp the event was fired
- `name: String`: The name of the event
- `group: String`: The group/category of the event
- `detail: String?`: A detail of the event (optional)
- `value: Double?`: A numeric value of the event (optional)
- `custom: [String]`: Custom data
Additionally, each event carries metadata. This metadata is usually the crucial part for the privacy of the user. Let's have a look at the metadata:
- `previousEvent: String?`: Event (name), that was triggered before this event within the same group
- `previousEventTimestamp: Day?`: Date (day precision), when an event of the same, was triggered last time
- `install: Day`: Date (day precision) when the user installed the app
*Note: There is no user id, no IP address or other identifying information about the user.*
## Privacy-preserving anonymous system
Each event is stored in a database with just the information listed above. Each event is isolated from the history, as the only two links to previous events are too unprecise to be chained together. This way, Beekeeper is anonymous and not only pseudonymous. This property is important for preserving the users' privacy, as [pseudonymous solutions can potentially be de-anonymized](https://iapp.org/news/a/looking-to-comply-with-gdpr-heres-a-primer-on-anonymization-and-pseudonymization/).
## Powerful insights
Beekeeper allows you to generate important insights about your app. A basic event that can be tracked in an app is the event of opening the app.
Your **daily app sessions** can then be calculated by just counting those events on a given day. The **daily active users** (who could have multiple sessions a day) can be calculated by just counting the events with a `previousEventTimestamp` of a past day. The same goes for _weekly_, *monthly* or other timeframes.
## Acknowledgments
Base icon made by [Eucalyp](https://www.flaticon.com/authors/eucalyp) from [Flaticon](https://www.flaticon.com/) with some custom coloring.