Skip to content

Add calendar, acquisition and retention parameters which are now sent with every event #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
winsmith merged 2 commits into from
Apr 30, 2025
Merged

Add calendar, acquisition and retention parameters which are now sent with every event #121

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f561f7
add: add calendar parameters which are now sent with every event
kkostov Apr 30, 2025
67041e7
add acquisition and retention
kkostov Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions ingest/default-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,24 @@
- `TelemetryDeck.Navigation.destinationPath` (String): The destination path of the navigation, e.g. `/host/info/about` or `app.settings.privacy`.
- `TelemetryDeck.Navigation.identifier` (String): String that uniquely identifies the navigation in the format `sourcePath -> destinationPath`.

## Acquisition Analytics


- `TelemetryDeck.Calendar.dayOfMonth`: The day-of-month (1..31) component of the date.
- `TelemetryDeck.Calendar.dayOfWeek`: The ISO 8601 number of the given day of the week. Monday is 1, Sunday is 7.
- `TelemetryDeck.Calendar.dayOfYear`: The 1-based day-of-year component of the date.
- `TelemetryDeck.Calendar.weekOfYear`: The week number within the current year as defined by `getFirstDayOfWeek()` and `getMinimalDaysInFirstWeek()`.
- `TelemetryDeck.Calendar.isWeekend`: `true` if the day of the week is Saturday or Sunday, `false` otherwise.
- `TelemetryDeck.Calendar.monthOfYear`: The number-of-the-month (1..12) component of the date.
- `TelemetryDeck.Calendar.quarterOfYear`: The the quarter-of-year (1..4). For API 26 and earlier, it's the number of the month divided by 3.

Check failure on line 167 in ingest/default-parameters.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Repetition] 'the' is repeated!

Raw Output:
{"message": "[Vale.Repetition] 'the' is repeated!", "location": {"path": "ingest/default-parameters.md", "range": {"start": {"line": 167, "column": 43}}}, "severity": "ERROR"}
- `TelemetryDeck.Calendar.hourOfDay`: The hour-of-day (0..23) time component of this time value.
- `TelemetryDeck.Acquisition.firstSessionDate`: The date of the first session e.g. 2025-02-22
- `TelemetryDeck.Retention.averageSessionSeconds`: The average session duration in seconds.
- `TelemetryDeck.Retention.distinctDaysUsed`: The number of distinct dates on which the app was used.
- `TelemetryDeck.Retention.totalSessionsCount`: The total number of sessions.
- `TelemetryDeck.Retention.previousSessionSeconds`: The duration of the previous session in seconds.
- `TelemetryDeck.Retention.distinctDaysUsedLastMonth`: The number of distinct dates on which the app was used in the last month.

## API

Information about which TelemetryDeck API this signal was sent to.
Expand Down