Progress Bar Points Granted - Appcharge Documentation

An event triggered when a player is granted Progress Bar points. Event Data

eventName

string

Event name: webstore.offers.progress_bar.points.granted.

eventId

string

Event ID. Use this ID to deduplicate re-delivered events.

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. This field is not currently in use.

reason

string

Reason for the event result. This field is not currently in use.

pointsGranted

integer

Number of points granted to the player upon offer purchase or collection.

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.

Show properties

string

Player ID.

string

Player’s email address.

name

string

Currently null. Reserved for the player’s name in future versions.

geolocation

object

Information about the player’s geolocation.

Show properties

countryCode2

enum

Two-letter country code in ISO-3166 alpha-2 format. Example: US

region

string

Region or state.

ipAddress

string

IP address in IPv4 format. Example: 80.178.249.122.

zipCode

string

Zip code.

utm

object

UTM data.

Show properties

utmSource

string

Source of the traffic. This is where the player came from before reaching the store. Example: Google.

utmMedium

string

Marketing channel used to bring in the traffic. Example: email.

utmCampaign

string

Identifies the marketing campaign associated with the traffic. Example: black_friday.

utmTerm

string

Paid search keyword or term that generated the traffic. Example: buy+coins.

utmContent

string

A label that identifies which version of content a player clicked to reach the web store. Useful for A/B testing and analyzing performance of different ad or link variations within the same campaign. Example: summer_sale_ad1

progressBar

object

Information about the Progress Bar.

Show properties

progressBarExternalId

string

Progress Bar external ID.

missionIndex

integer

Current mission index.

points

integer

Number of points the player has earned so far in the current mission.

products

[object]

List of products in the Progress Bar.

Show properties

productExternalId

string

Product external ID.

displayName

string

Product display name.

productQuantity

string

Product quantity.

pointsTarget

integer

Total number of points required to complete the current mission.

trigger

object

Information about the trigger.

Show properties

type

enum

Trigger type. Supported values:

purchase: An offer was purchased.
collect: An offer was collected.

orderRef

object

Reference to the order.

Show properties

offerExternalId

string

Offer external ID.

offerIndex

integer

Offer index.

orderId

string

Order ID.

sessionMetadata

any

Session metadata for passing data to Appcharge to be returned later.

{
  "eventName": "webstore.offers.progress_bar.points.granted",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1754307361396,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": null,
  "result": null,
  "reason": null,
  "pointsGranted": 20,
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "id": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "name": null,
    "email": "john.doe@gmail.com"
  },
  "geolocation": {
    "countryCode2": "US",
    "region": "Florida",
    "ipAddress": "192.168.1.1",
    "zipCode": "34997"
  },
  "utm": {
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "spring_sale",
    "utmTerm": "buy+coins",
    "utmContent": "ad1"
  },
  "progressBar": {
    "progressBarExternalId": "my-progress-bar-1",
    "missionIndex": 2,
    "points": 100,
    "products": [
      {
        "productExternalId": "treasure-12",
        "displayName": "Treasure",
        "productQuantity": "200"
      }
    ],
    "pointsTarget": 500
  },
  "trigger": {
    "type": "purchase",
    "orderRef": {
      "offerExternalId": "promo-id",
      "offerIndex": 1,
      "orderId": "69b81f12861bf68900b9cdff"
    }
  },
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}