Screen

Get started with the RudderStack Screen API call.

  •   less than a minute  

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

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

Sample Payload

Here is a sample payload of a screen call after removing most of the Common fields:

{
  "type": "screen",
  "name": "Main",
  "properties": {
    "title": "Home | RudderStack",
    "url": "http://www.rudderstack.com"
  }
}

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

[[RSClient sharedInstance] screen:@"Main"
                properties:@{
                  @"title" : "Home | RudderStack",
                  @"url" : @"http://www.rudderstack.com"}
                ];

Screen Fields

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

FieldTypePresenceDescription
nameStringOptionalScreen name
propertiesObjectOptionalProperties 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.

PropertyTypeDescription
nameStringYou can tag each screen with a name. This is a reserved property for future use.

Questions? Contact us by email or on Slack