Skip to main content
GET
Get per-screen analytics

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

screen_id
string
required

Screen identifier.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9._-]+$

Query Parameters

from
string

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

Example:

"2025-01-01"

to
string

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

Example:

"2025-12-31"

environment
string

Filter by environment.

currency
string

Currency code for revenue metrics (ISO 4217).

Example:

"USD"

unit
string

Time unit for grouping analytics data.

Response

Analytics data for the specified screen.

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.