getPopups
Retrieve a list of popups filtered by country, platform, type and optional field selection
Documentation
Request parameters:
| Name | Description | Type | Values | Default |
|---|---|---|---|---|
type | Popup type | string | "afterRegistration", "perPage", "crm" | - |
country | Country code to filter out blocked popups | string | - | - |
platform | Platform name | string | "desktop" / "mobile" | - |
Call example:
getPopups({
type: 'perPage',
country: 'AM',
platform: 'desktop'
})Response parameters:
| Name | Description | Type | Values |
|---|---|---|---|
id | Auto-increment unique identifier of the popup | number | - |
show_to | Visibility scope: 0 = all, 1 = authorized users only, 2 = guests only | number | - |
target | Link target attribute: "_blank", "_self", "_parent", or "_top" | string | - |
repeat_time | Number of times the popup can be repeated | number | - |
show_on_pages | List of page slugs the popup should appear on | array | - |
show_on_page | Primary page slug the popup is assigned to | string | - |
type | Popup trigger type: "after_registration", "per_page", "after_bet", or "crm" | string | - |
show_on_type | Display type identifier controlling how the popup is shown | number | - |
archived_at | Timestamp when the popup was archived, or null if still active | string | null | - |
title | Display title of the popup | string | - |
content | HTML content body of the popup | string | - |
href | URL the popup links to when clicked | string | - |
profile_types | List of restricted profile types. Empty array means no restriction | array | - |
profile_status | Required profile status for the popup to be shown | number | - |
custom_profile_types | List of custom profile type restrictions | array | - |
profile_action_type | Profile action type condition required to trigger the popup | number | - |
deposit_type | Deposit type condition required to trigger the popup | number | - |
first_deposit | Whether the popup is restricted to first deposit only (0 = no, 1 = yes) | number | - |