Data Model
This page describes the structure of data collected and sent by the Framedash SDK.
Events
Section titled “Events”All telemetry is sent as events. Each event has common fields and custom properties.
Common Fields
Section titled “Common Fields”| Field | Type | Description |
|---|---|---|
event_type | string | Type of event (e.g., performance_sample, player_death) |
timestamp | ISO 8601 | Time the event occurred |
session_id | UUID | Game session ID |
device_id | string | Device identifier |
build_id | string | Build version |
Performance Samples
Section titled “Performance Samples”Performance data automatically collected by the SDK:
| Field | Type | Unit |
|---|---|---|
fps | float | frames/sec |
frame_time | float | ms |
gpu_time | float | ms |
memory_used | int64 | bytes |
position | vec3 | world units |
Custom Events
Section titled “Custom Events”Game-specific events defined by the developer. You can store any JSON object in the properties field.
Sessions
Section titled “Sessions”A session represents the period from game launch to exit. Sessions include the following metadata:
- Device information (OS, GPU, RAM)
- Build information (version, profile)
- Player information (optional)
Next Steps
Section titled “Next Steps”- API Reference — Access data via the REST API
- Heatmaps — Visualizing position data