Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dldbdev/dldb_sdk_react_native
Behavioural analytics with the privacy by design
https://github.com/dldbdev/dldb_sdk_react_native
android app-analytics appanalytics data-analytics flutter gdpr ios privacy python react-native
Last synced: 2 days ago
JSON representation
Behavioural analytics with the privacy by design
- Host: GitHub
- URL: https://github.com/dldbdev/dldb_sdk_react_native
- Owner: dldbdev
- Created: 2022-01-25T11:45:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-02-07T15:52:21.000Z (over 2 years ago)
- Last Synced: 2024-09-17T12:58:31.502Z (16 days ago)
- Topics: android, app-analytics, appanalytics, data-analytics, flutter, gdpr, ios, privacy, python, react-native
- Language: Java
- Homepage: https://dldb.io/
- Size: 51.6 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# DLDB React Native
Welcom to the DLDB SDK beta for react native
- [Installation](#Installation)
- [Getting started](#getting-started)
- [Api and examples](#api-and-examples)
- [About DLDB](#about-dldb)
- [Support and contacts](#support-and-contacts)
## Installation
`$ npm install react-native-dldb --save`
`$ cd ios && pod install && cd ..`
## Getting started
```javascript
import dldb from 'react-native-dldb';
...
// at app start, after user consent
dldb.init(
'11111111-1111-1111-1111-111111111111',
'{"button" : "t","batteryLevel" : "i"}'
);
...
// once per day
dldb.heartbeat();
...
// on a very regular basis, when app idle ?
dldb.runQueriesIfAny();
...
// wherever useful
dldb.addEvents('{"button":"log in", "batteryLevel" : 55 }');
// location and event
dldb.addEventsWithLocation(
'{"batteryLevel" : 5 }',
{latitude : 45.0, longitude : 0.0, accuracy : 20}
);
// location only
dldb.addLocation(
{latitude : 45.0, longitude : 0.0, accuracy : 20}
);
```
## Api and examples
- [init](#init)
- [heartbeat](#heartbeat)
- [runQueriesIfAny](#runqueriesifany)
- [addEventsWithLocation](#addeventswithlocation)
- [addEvents](#addevents)
- [addLocation](#addlocation)
- [queriesLog](#querieslog)
- [locationsLog](#locationslog)
- [close](#close)
### init
Initialize the DLDB SDK with the dldbApiKey and events dictionary.
The dldbApiKey is required and can be obtained from the [DLDB dashboard](https://dashboard.dldb.io).
| parameter | type | description |
| ----------- |----------|------------------------------------------ |
| dldbApiKey | string | dpi key |
| eventsDictionaryAsJson | string | set of (event name, event type) as json |
The events dictionary is a json string containing one object per event. Each object defines the event name as a key and the values as the type of events : 't' for text, 'i' for numeric value.
A dictionary `{ "button" : "t", "batteryLevel": "i" }` defines 2 events : `button` with text value, and `batteryLevel` with numeric value.
The dictionary is meant to be a constant and can be changed only with new versions of your app.
The event names defined in this dictionary will the only events accepted by the functions [addEvents](#addEvents) and [addEventsWithLocation](#addEventsWithLocation)
*Example:*
```javascript
dldb.init(
'11111111-1111-1111-1111-111111111111',
'{"button" : "t","batteryLevel" : "i"}'
);
```
### heartbeat
to be called on a low frequency basis compatible with the app usage frequency, in order to provide accurate estimates of query response time to the dashboard.
*Example:*
```javascript
dldb.heartbeat();
```
### runQueriesIfAny
to be called on a regular basis compatible with the app usage frequency, in order to provide fast query responses to the dashboard. The more often it is called the faster the queries will be replied on dashboard
*Example:*
```javascript
dldb.runQueriesIfAny();
```
### addEventsWithLocation
| parameter | type | description |
| ----------- |----------|------------------------------------------ |
| eventsAsJson | string | The name and values of the events |
| location | object | the location of the events |
Events `eventsAsJson` can be any metric or KPI relevant for better understanding of end-user behaviour. All events provided through this call will be attached to the same second. If you do not have access to the location when this function is called, use [addEvents](#addEvents)
Event names must be present in the dictionary provided when calling [init](#init). Events with unknown names will be discarded.
The events will be attached to exactly the same instant, which will be the current second when the function is called, relying on device clock and time zone information.
`location` indicates where the events is happening.
| Property | Description |
| -------- | ------------- |
| latitude | in decimal degrees |
| longitude | in decimal degrees |
| accuracy | horizontal accuracy in meters aka the radius of the area, defaults to 100m if not present |
`longitude` and `latitude` are taken into account if both are present and valid values.
*Example:*
```javascript
// location and event
dldb.addEventsWithLocation(
'{"batteryLevel" : 5 }',
{latitude : 45.0, longitude : 0.0, accuracy : 20}
);
...
```
### addEvents
| parameter | type | description |
| ----------- |----------|------------------------------------------ |
| eventsAsJson | string | The name and values of the events |
Events `eventsAsJson` can be any metric or KPI relevant for better understanding of end-user behaviour. All events provided through this call will be attached to the same second. If you do have access to the location when this function is called, use [addEventsWithLocation](#addEventsWithLocation)
Event names must be present in the dictionary provided when calling [init](#init). Events with unknown names will be discarded.
The events will be attached to exactly the same instant, which will be the current second when the function is called, relying on device clock and time zone information.
*Example:*
```javascript
dldb.addEvents('{"button":"log in", "batteryLevel" : 55 }');
...
dldb.addEvents('{"batteryLevel" : 5 }');
...
```
### addLocation
| parameter | type | description |
| ----------- |----------|------------------------------------------ |
| location | object | the location of the events |
`location` indicates where the events is happening.
| Property | Description |
| -------- | ------------- |
| latitude | in decimal degrees |
| longitude | in decimal degrees |
| accuracy | horizontal accuracy in meters aka the radius of the area, defaults to 100m if not present |
`longitude` and `latitude` are taken into account if both are present and valid values.
*Example:*
```javascript
dldb.addLocation(
{latitude : 45.0, longitude : 0.0, accuracy : 20}
);
...
```
### queriesLog
| parameter | type | description |
| ----------- |----------|------------------------------------------ |
| maxEntries | number | the max number of entries to include in the log |
return a promise to the log of `maxEntries` most recent queries ran on the device.
The log is a json array (most recent last) of json objects, each object representing a query ran on the device
| Property | Description |
| -------- | ------------- |
| id | uuid of query |
| type | type of query |
| fetched | timestamp in ms when the query was fetched from server |
| answered | timestamp in ms when the query was answered on the device |
| finished | timestamp in ms when the query was finished on the device |
| tries | number of tries to run the query |
| json_in | parameters of the query |
| json_out | results of the query |
*Example:*
```javascript
onQueriesLog = async () => {
try {
const queriesLog = await dldb.queriesLog(5);
console.log(`Got the queries log ${queriesLog}`);
this.setState({
status: 'DLDB queries log',
message: queriesLog
});
} catch (e) {
console.error(e);
}
}
...
```
### locationsLog
| parameter | type | description |
| ----------- |----------|------------------------------------------ |
| durationInSeconds | number | how far back in the past to look for locations |
| maxEntries | number | the max number of entries to include in the log |
| resolution | number | resolution of returned locations |
return a promise to the log of at most `maxEntries` most recent unique locations stored on the device during the last `durationInSeconds`.
The log is a json array (most recent last) of [h3](https://h3geo.org) in hex string format, at resolution `resolution`.
A call to this function generates an entry into the queries log.
*Example:*
```javascript
onLocationsLog = async () => {
try {
const locationsLog = await dldb.locationsLog(5);
console.log(`Got the locations log ${locationsLog}`);
this.setState({
status: 'DLDB locations log',
message: locationsLog
});
} catch (e) {
console.error(e);
}
}
...
```
### close
to be called when shutting down the app.
*Example:*
```javascript
dldb.close();
```
## About DLDB
DLDB provides behavioural analytics for mobile applications with privacy by design.
DLDB architecture relies on an SDK to be integrated into your mobile application, and a dashboard https://dashboard.dldb.io/ to build, query, analyze the behaviour of your application users.
For your application, DLDB deploys a distributed database, where each database instance is inside the mobile application scope. All the analytics queries are run by the devices and no raw data ever leaves the devices. Only the statistical KPI-s are sent anonymously to the DLDB dashboard .
From the DLDB dashboard, developers, analysts and app owners can build their own queries and analyze the results. No need to have any additional storage or analytics platform: DLDB provides an end-to-end solution.
DLDB SDK is written in C and has bindings to most common languages - works natively on iOS, Android, React-Native and Flutter. We also have Python binding and C libraries for IoT devices.
### Highlights
- Seamless integration of DLDB SDK into your mobile app source base, in many flavours, on all major platforms
- Define your own schema of collected events and values
- Built-in GDPR compliance on the right to be forgottent: all data belonging to your user stays on the device, so delete the data whenever requested
- Built-in GDPR compliance on the traceability of data usage: all requests processed by the DLDB SDK are traced and can be shown on demand
- No additional online storage
- Rapid scaling
## Support and contacts
If you face any problems or have any questions, please contact us
support channel in Discord: https://discord.gg/TD4f6p6nUH
email: [email protected]
web: https://dldb.io/
subscribe for product updates and news: https://dldb.io/#Beta