v1

latestOpenAPI 3.0.3Elastic License 2.02026-07-1712727.3 KB

HTTP API

Screen

The screen call is the mobile equivalent of the page call. It lets you record whenever your user views their mobile screen with any additional relevant information about the screen.

post/v1/screen

Request body

userIdstring

Unique identifier for a particular user in your database.

anonymousIdstring

Sets the user ID for cases where there is no unique identifier for the user.

namestring

Name of the screen being viewed.

propertiesobject

Dictionary of the properties associated with the page being viewed, such as url and referrer.

timestampstring date-time

The timestamp of the message’s arrival.

Response

StatusOK