v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB

Triggered Popups

Get Store Refresh Popup

Retrieves one or more store refresh popups.

get/v2/offer

Query parameters

publisherOfferIdsstring required

Example:store-refresh-offer-1,store-refresh-offer-2

The unique identifier for the offer. To retrieve multiple store refresh popups, separate them with a comma.

Headers

x-publisher-tokenstring required

The publisher token used for authentication.

Response

Store Refresh Popup retrieved successfully.

totalCountnumber

Total number of matching offers.

Example response

{
  "offers": [
    {
      "offerUi": {
        "offerUiId": "68b41c5aa1c5b1a284737e9b",
        "offerExternalUiId": "Real_Store_Refresh"
      },
      "productsSequence": [
        {
          "index": 1,
          "products": [
            {
              "publisherProductId": "green_diamond",
              "quantity": 1,
              "priority": "Main"
            }
          ],
          "priceInUsdCents": 99,
          "playerAvailability": 10,
          "hidePlayerAvailability": true
        }
      ],
      "displayRule": {
        "frequency": 3,
        "cooldownInMinutes": 1
      },
      "schedule": {
        "timeFrames": [
          {
            "startTime": "2026-05-02T00:00:00.000Z",
            "endTime": "2026-05-04T23:59:59.000Z",
            "notes": "Initial weekend rollout"
          }
        ]
      },
      "productSale": {
        "sale": 30,
        "type": "percentage"
      },
      "priceDiscount": {
        "discount": 25,
        "type": "percentage"
      },
      "badges": [
        {
          "publisherBadgeId": "best_value"
        }
      ]
    }
  ]
}