v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB

Screens

Get per-screen analytics

Returns analytics metrics for a single screen. Supports optional time-range, environment, currency, and unit filters.

get/screens/{screen_id}/analytics

Path parameters

screen_idstring required

Screen identifier.

Query parameters

fromstring

Example:2025-01-01

Start of the analytics period (ISO 8601 date or datetime).

tostring

Example:2025-12-31

End of the analytics period (ISO 8601 date or datetime).

environmentstring

Filter by environment.

currencystring

Example:USD

Currency code for revenue metrics (ISO 4217).

unitstring

Time unit for grouping analytics data.

Response

Analytics data for the specified screen.

object required

Analytics object wrapped in the standard v4 envelope (object, url, data). data.kpis uses snake_case keys (conversion_rate, cancel_rate) and each KPI carries value, previous-period value, and a sparkline.