Merge pull request #121 from TelemetryDeck/docs/add-default-parameters

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

Author: winsmith

ingest/default-parameters.md

@@ -155,6 +155,24 @@ Navigation analytics signals have these parameters, which can be included in any
 - `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.
+- `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.