Module params

Module params 

Source
Expand description

Reserved parameter name constants defined by TelemetryDeck

See the params module documentation for usage examples. Reserved parameter name constants defined by TelemetryDeck

This module provides pre-defined parameter names for common telemetry data. Using these constants ensures your signals are properly recognized by TelemetryDeck’s analytics engine and can be used in built-in dashboards.

§Example

use telemetrydeck_wasm::{TelemetryDeck, params};
use std::collections::HashMap;

let client = TelemetryDeck::new("YOUR-APP-ID");

let mut payload = HashMap::new();
payload.insert(params::device::PLATFORM.to_string(), "iOS".to_string());
payload.insert(params::device::SYSTEM_VERSION.to_string(), "17.0".to_string());
payload.insert(params::user_preferences::LANGUAGE.to_string(), "en".to_string());

client.send("appOpened", Some("user"), Some(payload), None, None);

§Available Parameter Categories

  • accessibility - Accessibility settings (font scale, reduced motion, etc.)
  • acquisition - User acquisition data (first session, channel, etc.)
  • device - Device information (platform, OS, architecture, etc.)
  • navigation - Navigation paths and routes
  • purchase - Purchase details (type, price, currency, etc.)
  • retention - User retention metrics (session count, duration, etc.)
  • calendar - Time-based information (day, week, month, etc.)
  • run_context - Runtime environment (locale, marketplace, etc.)
  • user_preferences - User preferences (language, color scheme, etc.)

Modules§

accessibility
Accessibility-related parameters
acquisition
Acquisition-related parameters
calendar
Calendar-related parameters
device
Device-related parameters
navigation
Navigation-related parameters
purchase
Purchase-related parameters
retention
Retention-related parameters
run_context
Run context parameters
user_preferences
User preference parameters