Screen

Get started with the RudderStack Screen API call.

The screen call lets you record whenever your user views their mobile screen, with any additional relevant information about the screen.

The screen call is the mobile equivalent of the page call.

Sample payload

A sample payload of a screen event after removing most of the Common fields is shown below:

json

{
  "type": "screen",
  "name": "Main",
  "properties": {
    "title": "Home | RudderStack"
  }
}

The corresponding screen call that generates the above payload via the iOS (Obj-C) SDK is as follows:

objectivec

[[RSClient sharedInstance] screen:@"Main"
                properties:@{
                  @"title" : "Home | RudderStack"}
                ];

The screen call supports the following fields in addition to the Common fields:

Field	Type	Presence	Description
`name`	String	Optional	Screen name
`properties`	Object	Optional	Properties of the screen such as the `url`, `referrer`, etc. For more more information, check the Properties section below.

Properties are additional information that describe the viewed screen.

RudderStack has reserved some standard properties listed in the table below and handles them in special ways.

Property	Type	Description
`name`	String	You can tag each screen with a `name`. This is a reserved property for future use.