Screen

Detailed technical description of the 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 call with most of the Common Fields removed is as shown:

{
"type": "screen",
"name": "Main",
"properties": {
"prop_key": "prop_value"
}
}

The corresponding event that generates the above payload via the iOS SDK is as shown:

[[RSClient sharedInstance] screen:@"Main"
properties:@{@"prop_key" : @"prop_value"}];

Screen Fields

Apart from the Common Fields, the screen call accepts the following fields:

Field

Type

Presence

Description

name

String

Optional

The name of the screen.

properties

Object

Optional

Includes the properties of the screen such as the url, referrer, etc. For more more information, check the Properties section below.

Properties

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.

Contact Us

For more information on any of the sections covered in this doc, you can contact us or start a conversation on our Slack channel.