Skip to main content
POST
Screen

Description

Record a mobile screen view. Used by mobile SDKs automatically when screen auto-tracking is enabled, or manually when you want to attach screen-specific properties. Short alias: POST /v1/s When to use:
  • Mobile apps to track navigation flow
  • Attribute screen-level data (product ID, category) to the view event

Headers

string
required
HTTP Basic Auth. See Events Authentication.
string
default:"application/json"
required
Must be application/json.

Body

string
Identified user ID. At least one of userId or anonymousId is required.
string
Anonymous user ID. Required if userId is not provided.
string
Screen name (for example "Product Detail").
string
Screen category.
object
Screen-specific properties (for example product_id, category, price).
string
When the screen view occurred, as ISO 8601.
object
Optional environment metadata (device, OS, app, IP, locale, and more). SDKs populate this automatically. See Context Object.

Response

Successful requests return HTTP 200 with an empty JSON object.