Screens are the no-code paywalls and onboarding flows built in the Qonversion dashboard or programmatically via the API. Each screen has a draft and a published version; users see the published version in the app.Documentation Index
Fetch the complete documentation index at: https://documentation.qonversion.io/llms.txt
Use this file to discover all available pages before exploring further.
Key concepts
- Draft vs. published — Edits create a new draft;
POST /v4/screens/{screen_id}/publishpromotes it. - Context key — Screens are shown in the SDK via
NoCodes.showScreen(contextKey). - Copy —
POST /v4/screens/{screen_id}/copyduplicates a screen, useful when forking variants. - Analytics — Per-screen and overview analytics are available under
/v4/screens/analytics/…. - Summary vs. full payload —
GET /v4/screens/{screen_id}returns the fullV4Screenwith render-time fields by default. Pass?render=falseto get the leanV4ScreenSummary(same shape as list rows) when you only need metadata and want to skip the render payload (configs,content,prod_key,sandbox_key,background,default_lang,used).
Available endpoints
| Method | Endpoint | Description | Status |
|---|---|---|---|
| GET | /screens | List screens | New |
| POST | /screens | Create a screen | New |
| GET | /screens/analytics/overview | Get screens analytics overview | New |
| DELETE | /screens/{screen_id} | Delete a screen | New |
| GET | /screens/{screen_id} | Get a screen | New |
| PUT | /screens/{screen_id} | Update a screen | New |
| GET | /screens/{screen_id}/analytics | Get per-screen analytics | New |
| POST | /screens/{screen_id}/copy | Duplicate a screen | New |
| POST | /screens/{screen_id}/publish | Publish a screen | New |
Authentication
All v4 endpoints require a Secret Key. See Authentication.Programmatic creation, dashboard editing
POST /v4/screens only takes a name. It creates an empty draft — the layout, media, components, and localisations are then built in the Qonversion dashboard’s no-code editor, which fills in configs, content, background, default_lang, prod_key, and sandbox_key over the life of the screen. Once a screen is published, the prod_key / sandbox_key values are what the Qonversion SDKs use at runtime.