Playable's API integrations allow a wide range of campaign and reporting data to be queried and for example, used in email flows, CRM systems and internal dashboards.
In this article we will provide an extensive overview of the data that is available across gametypes and can be transferred via API solutions.
The information that can be collected and transferred can be divided into 5 different types:
Form field information
Campaign information
Static information
Metrics data (Game information)
Prize information
Form field data
Form field data is collected via registration forms. In this article you can gain an overview of the different data points.
Campaign information
Name | Description | Example |
Registration ID | Unique ID for the each participation. The ID is unique for each registration even though it is the same user playing. | 587666593 |
Campaign name | This is the name of the campaign set under Camapign settings. | 2024 Q1 Quiz |
Campaign ID | The ID of the campaign and this is not something that can be changed. | 136353 |
Created on | The date and time for when a registration was created. This can be adjusted in the integration to match the desired format. | dd-mm-yyyy hh:mm:ss |
Device | Device the user used | Desktop, Mobile |
IP | The IP address of the participant | 80.167.234.2 |
Created from URL | The URL the user access the from, this URL includes utm and URL parameters | |
Campaign URL | The URL of the campaign | |
Gameflow status | This will tell you whether a user won or lost. This information is only available when a user completes the game | Won/Lost |
Game type | This is the game chosen, so whether it is a dropgame or a quiz. | Quiz |
Static information
Static information is information that can be added to every registration, without the data needs to be collected in the registration form. Static information is manually added by a campaign administrator and is therefore not a generic value across campaigns. For example, you can use static information if you want to track Playable as the user "source" in your database. It is important to note, that static information is added to every registration meeting the integration conditions.
Metric data
This is game specific information.
Personality test
| Quiz
| Rock paper scissors
|
Drop game
| Wheel of fortune
| Scratch card
|
Memory game
| Calendar
| Spot the difference
|
Guess the picture
| Guess the word
| Video quiz
|
Spin the bottle
| Hit the target
| Swipe it
|
Puzzle
| Slot machine
| Tapping
|
Sliding puzzle
| Slice it
| Place the item
|
Bounce battle
| Shoot it
| Snake
|
Lucky number
| Poll
| Shell
|
Sudoku
| Roulette
| Priority game
|
Product selector
| Prediction
| Survey
|
Hit a Mole
| Roll the dice
|
|
Prize information
Prize information is information tied to the prize the user has won.
Name | Description | Example |
ESP identifier | A value that can be set to identify the prize or send over a custom value not know to the end user | 200Voucher |
Prize code | Custom code that is added to the bulk prize upload in case you want custom code for each reward | 12345GH67 |
Custom URL | Custom URL added to the bulk prize upload in case you want custom URLs for each reward | |
Voucher URL | This is the voucher URL which is created for each prize if the functionality is activated |
|
Prize name | The name of the prize is determined in the creation of the prize | Voucher |
Prize description | The description of the prize determined in the creation of the prize | Congratulation on the voucher |
Prize value | The value of the prize is determined in the creation of the prize | 200 |
Prize image | The image patch on the prize created | https:\/\/files.cdn.leadfamly.com\/files\/630\/uploads\/bbf35888-8c45-491c-9ac2-a124c94a3066.jpeg |