Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.appcharge.com/llms.txt

Use this file to discover all available pages before exploring further.

An event triggered when 100% of an offer’s visual element is visible to the player. Events are batched every second and include only newly shown offers, excluding previously reported ones. The list resets after a page refresh. Event Data
​
eventName
string
Event name: webstore.offers.displayed.
​
eventId
string
Event ID.
​
timestamp
number
Event timestamp in Epoch time, represented in milliseconds. Example: 1754307361396.
​
sessionId
string
The session ID of the player’s current session. Example: 345397c6-d963-4aa4-a0ba-2aaca6c3ee05.
​
requestId
string
ID assigned by Appcharge to each request sent to the publisher. Helps the publisher identify and debug failed requests.
​
result
string
Event result. Supported values: success, failed.
​
reason
string
Reason for the event result. Example: invalid_credentials.
​
attributes
map<any,any>
A key-value map used to label events for tracking personas or tests. Example: { "persona":"non_payer", "blackFridayTest":"Base_group" }
​
customer
object
Information about the player.
​
offers
[object]
List of offers.
​
progressBars
[object]
List of Progress Bars.
​
device
object
Information about the player’s device.
​
geolocation
object
Information about the player’s geolocation.
​
sessionMetadata
any
Session metadata for passing data to Appcharge to be returned later.
{
  "eventName": "webstore.offers.displayed",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1754307361396,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": "23539478-c744-566a-c78c-c4cc7763ff62",
  "result": "success",
  "reason": "invalid_credentials",
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "id": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "email": "john.doe@gmail.com",
    "name": "John Doe"
  },
  "offers": [
    {
      "externalId": "22ae81bb-55ef-428b-97ba-f67783971e4a",
      "type": "SpecialOffer",
      "subType": null,
      "name": "Spring Is Here",
      "offerIndex": 1,
      "indexToCollect": "1", 
      "tab": "Knight Guard",
      "pricePoint": 800,
      "price": 800,
      "currencyCode": "USD",
      "products": [
        {
          "displayName": "Gold Coins",
          "productExternalId": "31ae81bb-55ef-428b-97ba-f67783971e553",
          "productQuantity": "1000"
        },
        {
          "displayName": "Silver Shield",
          "productExternalId": "9af1abb-55ef-428b-97ba-f677839716ac9",
          "productQuantity": "40"
        }
      ]
    }
  ],
  "progressBars": [
    {
      "progressBarExternalId": "my-progress-bar-1",
      "missionIndex": 2,
      "points": 100,
      "products": [
        {
          "productExternalId": "treasure-12",
          "productQuantity": "200"
        }
      ],
      "pointsTarget": 500
    }
  ],
  "device": {
    "platform": "iOS",
    "deviceModel": "iPhone 16 Pro",
    "osType": "Apple",
    "osVersion": "18",
    "browserType": "Google Chrome",
    "browserVersion": "138"
  },
  "geolocation": {
    "countryCode2": "US",
    "region": "Florida",
    "ipAddress": "192.168.1.1.",
    "zipCode": "34997"
  },
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}