In this article
The different events collected when enabling the Piano integration.
PianoStandard
PianoStandard
There are some event properties that are present in most of the Piano events we track:
| Name | ID | Type | Required | Description |
| Client domain | client.domain | String | Optional | The domain the event fired on |
| Client referrer | client.referrer | String | Optional | The referrer to the URL |
| Client title | client.title | String | Optional | The title of the web page the event occurred on (shown in the page tab) |
| Client type | client.type | String | Optional | The type of the client, e.g. AMP, FIA, web, iOS, Android |
| Client URL | client.url | String | Optional | The URL of the web page the event occurred on |
| Client user agent | client.user_agent | String | Optional | The user agent of the client the event occurred on |
PianoAccess
This event is fired when a user has logged in and has access to their subscription content:
| Name | ID | Type | Required | Description |
| Access ID | access_id | String | Optional | The ID of the access that is associated with the webhook |
| AID | aid | String | Optional | Application ID. |
| Event | event | String | Optional | An event that resulted in new access |
| Expires | expires | Date/Time | Optional | When the access sent in the webhook expires |
| RID | rid | String | Optional | The resource ID against which the webhook is being sent |
| Term ID | term_id | String | Optional | The id of the term (product) that the webhook is associated with |
| Type | type | String | Required | The type of the webhook |
| UID | uid | String | Optional | The user ID |
| Version | version | Integer | Optional | The version of the webhook |
PianoLoginRequiredThis event is fired when a user is asked to login as a subscriber/trialist:
| Name | ID | Type | Required | Description |
| Container Selector | container_selector | String | Optional | The type of container shown to the user (eg. the pop up style) |
| Experience Action ID | experience.action_id | String | Optional | The id given to the action of the experience |
| Experience Execution ID | experience.execution_id | String | Optional | The id given to the execution of the experience |
| Experience ID | experience.id | String | Optional | The id of the experience the user has gone through to reach the login required page |
| Offer ID | offer_id | String | Optional | The offer id given to the offer the user was shown |
| Start Screen | start_screen | String | Optional | The page the user was on when asked to login |
| Template ID | template_id | String | Optional | The template id given to the template the user was shown |
| Term ID | term_id | String | Optional | The id given to the term |
PianoShowTemplate
This event is fired when a user has accessed your subscription paywall:
| Name | ID | Type | Required | Description |
| Container Selector | container_selector | String | Optional | The type of container shown to the user (eg. the pop-up style) |
| Experience Action ID | experience.action_id | String | Optional | The id given to the action of the experience |
| Experience Execution ID | experience.execution_id | String | Optional | The id given to the execution of the experience |
| Experience ID | experience.id | String | Optional | The id of the experience the user has gone through to be shown the offer |
| Meter Max Views | meters.max_views | Integer | Optional | The maximum number of page views possible before the meter runs out |
| Meter Name | meters.name | String | Optional | The name you have given the meter |
| Meter Total Views | meters.total_views | Integer | Optional | The total number of views the user has on their meter |
| Meter Views | meters.views | Integer | Optional | The number of views a user has had on their meter |
| Meter Views Left | meters.views_left | Integer | Optional | The number of views a user has left on their meter |
| Offer ID | offer_id | String | Optional | The offer id given to the offer the user was shown |
| Template ID | template_id | String | Optional | The template id given to the template the user was shown |
PianoCheckout
This event is fired when a user begins the subscription checkout:
| Name | ID | Type | Required | Description |
| Container Selector | container_selector | String | Optional | The type of container shown to the user (eg. the pop up style) |
| Experience ID | experience.id | String | Optional | The id of the experience the user has gone through to reach the checkout |
| iFrame ID | iframe_id | String | Optional | The iframe id given to the offer the user was shown |
| Offer ID | offer_id | String | Optional | The offer id given to the offer the user was shown |
| Template ID | template_id | String | Optional | The template id given to the template the user was shown |
| Term ID | term_id | String | Optional | The id given to the term |
This event is fired when a user is shown a subscription offer:
| Name | ID | Type | Required | Description |
| Container Selector | container_selector | String | Optional | The type of container shown to the user (eg. the pop up style) |
| Experience Action ID | experience.action_id | String | Optional | The id given to the action of the experience |
| Experience Execution ID | experience.execution_id | String | Optional | The id given to the execution of the experience |
| Experience ID | experience.id | String | Optional | The id of the experience the user has gone through to be shown the offer |
| Offer ID | offer_id | String | Optional | The offer id given to the offer the user was shown |
| Template ID | template_id | String | Optional | The template id given to the template the user was shown |
This event is fired when a user closes the subscription checkout with or without completion:
| Name | ID | Type | Required | Description |
| State | state | String | Optional | Whether the checkout was completed or not (eg. close, checkoutCompleted, alreadyHasAccess) |
This event is fired when a user completes the subscription checkout:
| Name | ID | Type | Required | Description |
| Charge Amount | charge_amount | Float | Optional | The amount the user was charged at checkout |
| Charge Currency | charge_currency | String | Optional | The currency of the amount the user was charged |
| Expires At | expires_at | Date/Time | Optional | The date and time the subscription expires |
| Resource ID | resource_id | String | Optional | The id given to the resource |
| Started At | started_at | Date/Time | Optional | The date and time the subscription began |
| Term Conversion ID | term_conversion_id | String | Optional | The id given to the conversion after a user has completed checkout |
| Term ID | term_id | String | Optional | The id given to the term |
| User ID | user_id | String | Optional | The id given to the user |
PianoMeter
This event is fired when a user has a subscription meter active:
| Name | ID | Type | Required | Description |
| Meter Max Views | max_views | Integer | Optional | The maximum number of page views possible before the meter runs out |
| Meter Name | name | String | Optional | The name you have given the meter |
| Meter Total Views | total_views | Integer | Optional | The total number of views the user has on their meter |
| Meter Views | views | Integer | Optional | The number of views a user has had on their meter |
| Meter Views Left | views_left | Integer | Optional | The number of views a user has left on their meter |
This event is fired when a users subscription meter expires:
| Name | ID | Type | Required | Description |
| Meter Max Views | max_views | Integer | Optional | The maximum number of page views possible before the meter runs out |
| Meter Name | name | String | Optional | The name you have given the meter |
| Meter Total Views | total_views | Integer | Optional | The total number of views the user has on their meter |
| Meter Views | views | Integer | Optional | The number of views a user has had on their meter |
| Meter Views Left | views_left | Integer | Optional | The number of views a user has left on their meter |
If you have any questions, please contact Customer Support by emailing support@permutive.com or chat with the Customer Operations Team via the LiveChat icon in the bottom right corner of your screen.
Comments
0 comments
Article is closed for comments.