REST API
The Promo Banner extension exposes its Banners, Placeholders, and Analytics data through the standard Magento REST API, so you can manage them programmatically or pull banner performance data into external systems.
All endpoints require a Magento access token (integration or admin token) with access to the corresponding ACL resource - see the access permissions tip on the Banners page. For general authentication and request/response details, refer to the Magento REST API developer guide.
Banners - /V1/mirasvit-banner/banners
Manage banners. Requires the Banners ACL resource.
| Method | Endpoint | Description |
|---|---|---|
| GET | /V1/mirasvit-banner/banners | List banners (supports standard searchCriteria filtering) |
| GET | /V1/mirasvit-banner/banners/:bannerId | Get a single banner by ID |
| POST | /V1/mirasvit-banner/banners | Create a banner |
| PUT | /V1/mirasvit-banner/banners/:bannerId | Update a banner |
| DELETE | /V1/mirasvit-banner/banners/:bannerId | Delete a banner |
Key fields on a banner object mirror the Banner settings: name, is_active, active_from, active_to, store_ids, customer_group_ids, placeholder_ids, sort_order (Priority), conditions_serialized, content, and url.
Placeholders - /V1/mirasvit-banner/placeholders
Manage placeholders. Requires the Banner Placeholders ACL resource.
| Method | Endpoint | Description |
|---|---|---|
| GET | /V1/mirasvit-banner/placeholders | List placeholders (supports standard searchCriteria filtering) |
| GET | /V1/mirasvit-banner/placeholders/:placeholderId | Get a single placeholder by ID |
| POST | /V1/mirasvit-banner/placeholders | Create a placeholder |
| PUT | /V1/mirasvit-banner/placeholders/:placeholderId | Update a placeholder |
| DELETE | /V1/mirasvit-banner/placeholders/:placeholderId | Delete a placeholder |
Key fields: name, is_active, renderer (Display mode), layout_position, conditions_serialized (Display conditions), identifier, css (Additional CSS), and additional (the renderer-specific settings, e.g. delay, cookie_lifetime, autoplay, popup_position, mask_color - see Placeholder settings).
Analytics - /V1/mirasvit-banner/analytics
Read-only impression/click statistics per banner. Requires the Banners ACL resource.
| Method | Endpoint | Description |
|---|---|---|
| GET | /V1/mirasvit-banner/analytics | List analytics for all banners |
| GET | /V1/mirasvit-banner/banners/:bannerId/analytics | Get analytics for a single banner |
Fields: banner_id, impressions, clicks, ctr (click-through rate).