Screen

The Screen Tracking feature enables you to monitor user interactions within your application by recording screen views and associated properties.

The screen call records when a user views a specific screen in your app, along with optional properties that provide additional context about the screen.

Example Screen Event Payload
{
  "id": "viz_7893c51ee9662",
  "userId": "1247c47a-98b6-52cd-1299-bc7e8b658add",
  "otherIds": {
    "trackerId": "1247c47a-98b6-52cd-1299-bc7e8b658add"
  },
  "context": {
    "library": {
      "name": "android sdk",
      "version": "1.2.3"
    },
    "app": {
      "name": "MyFitnessApp",
      "version": "1.4.0",
      "build": "1.4.0.102"
    },
    "device": {
      "id": "D8392EF0-F12E-11E4-8DFC-AA07A5B093DB",
      "advertisingId": "3C7D9AE0-CDF5-11E4-8DFC-AA07A5B093DB",
      "adTrackingEnabled": true,
      "manufacturer": "Samsung",
      "model": "Galaxy S21",
      "type": "android",
      "token": "abc15bc0c20c4aa6cd50854ff165fd265c838e5405bfeb9571066395b8c9da449"
    },
    "screen": {
      "width": 1080,
      "height": 2400,
      "density": 3
    },
    "userAgent": {
      "osType": "Android",
      "osVersion": "11"
    },
    "ip": "192.168.1.1"
  },
  "name": "workoutSummary",
  "messageId": "ajs-8cfa5e4de5024d9430b3928bd8bff2a5",
  "properties": {
    "completedExercises": 8,
    "totalTime": "45 mins",
    "caloriesBurned": 350
  },
  "receivedAt": "2024-12-16T19:30:01.366Z",
  "sentAt": "2024-12-16T19:30:01.269Z",
  "timestamp": "2024-12-16T19:30:01.349Z",
  "type": "screen",
  "originalTimestamp": "2024-12-16T19:30:01.252Z",
  "writeKey": "abcd3Zghe5jHvjWh"
}

By utilizing the screen call, you can gain deeper insights into user behavior and interactions within your application, enabling more effective analysis and optimization of the user experience.