3rd party integrations
...
Purple Tracking
Tracking Events

Placeholder

36min
getting started a purple application technically consists of a native app part and an experience part that runs within a web view the placeholders in this documentation are listed under the placeholder docid\ hwgaxh6bt5orbprp0v9vg or placeholder docid\ hwgaxh6bt5orbprp0v9vg subchapters based on the origin they occur in addition, event specific placeholders are listed explicitly in the subchapters placeholder docid\ hwgaxh6bt5orbprp0v9vg native app content parameter placeholder description content id the content id is composed of the issues publication id and issue id value is based on this template < < publication id >/< issue id > content name the content name comes from the name of the issue example for composing the value of content id if the puplication has the id " my publication id my publication id " and the issue has the id " my issue id my issue id " the result will be " my publication id/my issue id my publication id/my issue id " bookmark parameter placeholder description bookmark section the section comes from the section within toc bookmark title the bookmark title comes from the name of the issue issue parameter placeholder description issue id the id of the issue issue name the name of the issue all custom issue properties a list of key/value pairs key/value pairs with empty values are omitted for tracking the key names are based on the custom property names the custom property names are transformed before use key is based on this template property < property < transformed name of custom property > transform is done as follows custom property name is converted to uppercase hyphens are replaced with underscores example for custom property transformation if there is a custom property like this " my custom issue property " the transform finally leads to " property my custom issue property " page parameter placeholder description page alias the alias of the page page id the id of the page page index the index of the page page label the label of the page page number the number of the page page section the section of the page page title the title of the page publication parameter placeholder description publication id the id of the publication publication name the name of the publication all custom publication properties a list of key/value pairs key/value pairs with empty values are omitted for tracking the key names are based on the custom property names the custom property names are transformed before use key is based on this template property < property < transformed name of custom property > transform is done as follows custom property name is converted to uppercase hyphens are replaced with underscores example for custom property transformation if there is a custom property like this " my custom publication property " the transform finally leads to " property my custom publication property " experience bookmark parameter placeholder description bookmark creation date the date the bookmark was created bookmark description the description of the bookmark bookmark page label the page label of the referenced page from the issue bookmark title the title of the bookmark custom bookmark data a list of key/value pairs key/value pairs with empty values are omitted for tracking the key names are based on the custom data names the custom data names are transformed before use key is based on this template bookmark custom data \<transformed custom data name> bookmark custom data \<transformed custom data name> transform is done as follows custom property name is converted to uppercase hyphens are replaced with underscores example for custom property transformation if there is a custom property like this " my custom bookmark data property " the transform finally leads to " bookmark custom data my custom bookmark data property " category parameter placeholder description category id the id of category category name the name of category category parent category id the id of the parent category all custom category properties a list of key/value pairs key/value pairs with empty values are omitted for tracking the key names are based on the custom property names the custom property names are transformed before use key is based on this template category property \<transformed name of custom property> category property \<transformed name of custom property> transform is done as follows custom property name is converted to uppercase hyphens are replaced with underscores example for custom property transformation if there is a custom property like this " my custom category property " the transform finally leads to " category property my custom category property " issue some events will not include the price in that case the placeholders issue price , issue price currency and issue price value are not available parameter placeholder description issue id the id of the issue issue latest indicates whether the issue is the current one or not within its publication issue name the name of the issue issue price formatted price when the price is available issue price currency currency of price when the price is available issue price value value of price when the price is available issue product id the product id to purchase that issue by single purchase issue purchasable indicates if that issue is purchasable issue purchased indicates if that issue has already been purchased issue type the value of this field is " issue issue " all custom issue properties a list of key/value pairs key/value pairs with empty values are omitted for tracking the key names are based on the custom property names the custom property names are transformed before use key is based on this template issue property \<transformed name of custom property> issue property \<transformed name of custom property> transform is done as follows custom property name is converted to uppercase hyphens are replaced with underscores all source issue parameters a list of parameter placeholders for the source issue source parameter is based on this template source \<issue parameter> source \<issue parameter> example for custom property transformation if there is a custom property like this " my custom issue property " the transform finally leads to " issue property my custom issue property " product parameter placeholder description product description the description of the product product hidden indicates wether this product is hidden or not product id the id of the product product name the name if the product product price the formatted price of the price product price currency the currency of the price product price value the value of the price product purchased indicates if the product is purchased by the user product type the type of the product all custom product properties a list of key/value pairs key/value pairs with empty values are omitted for tracking the key names are based on the custom property names the custom property names are transformed before use key is based on this template product property \<transformed name of custom property> product property \<transformed name of custom property> transform is done as follows custom property name is converted to uppercase hyphens are replaced with underscores example for custom property transformation if there is a custom property like this " my custom product property " the transform finally leads to " product property my custom product property " publication parameter placeholder description publication id the id of the publication publication name the name of the publication publication type the type of the publication all custom publication properties a list of key/value pairs key/value pairs with empty values are omitted for tracking the key names are based on the custom property names the custom property names are transformed before use key is based on this template publication property \<transformed name of custom property> publication property \<transformed name of custom property> transform is done as follows custom property name is converted to uppercase hyphens are replaced with underscores all parameters of the related source publication a list of parameter placeholders for the source publication source parameter is based on this template source \<publication parameter> source \<publication parameter> example for custom property transformation if there is a custom property like this " my custom publication property " the transform finally leads to " publication property my custom product property " subscription parameter placeholder description subscription duration the duration of the subscription subscription id the id oft the subscription subscription name the name of the subscription subscription price the formatted price of the price subscription price currency the currency of the price subscription price value the value of the price subscription product id the product id of the subscription subscription purchased indicates if the subscription is purchased by the user subscription type the type of the subscription all custom subscription properties a list of key/value pairs key/value pairs with empty values are omitted for tracking the key names are based on the custom property names the custom property names are transformed before use key is based on this template subscription property \<transformed name of custom property> subscription property \<transformed name of custom property> transform is done as follows custom property name is converted to uppercase hyphens are replaced with underscores example for custom property transformation if there is a custom property like this " my custom subscription property " the transform finally leads to " subscription property my custom subscription property " content open some events will provide these placeholders when the corresponding issue was opened by the javascript api " content open " parameter placeholder description issue categories the categories of the issue as comma separated list issue latest indicates whether the issue is the current one or not within its publication issue product id the product id to purchase that issue by single purchase issue purchasable indicates if that issue is purchasable issue purchased indicates if that issue has already been purchased issue tags the tags of the issue as comma separated list issue type the value of this field is " issue issue " publication type the type of the publication view context for action events parameter placeholder description view the view name within the action event was triggered view context for view events parameter placeholder description popup indicates whether the view was opened within a popup possibles values are true or false view the view name within the view event was triggered event specific content open failed parameter placeholder description issue possible values are "< issueid issueid >" "alias/< alias alias >" "external id/< external issue id external issue id >" presenter article visibility parameter placeholder description article id the id of the article percentage in view the percentage in view for this article presenter content url opened parameter placeholder description url the value of the url storefront < content type content type > search result page hit clicked parameter placeholder description page index the index of the page page label the label of the page page number the number of the page page title the title of the page storefront html link open < action action > actions are as follows app browser app browser external external inline inline parameter placeholder description link text the text for the link target url the value of the url storefront login link clicked parameter placeholder description target url the value of the url storefront popup close clicked parameter placeholder description popup indicates if a view is shown within a popup or not storefront product load failed parameter placeholder description error the error which occurs while loading product information productid the product id storefront search performed parameter placeholder description phrase the phrase the user searched for storefront subscription code < action action > actions are as follows activated activated activated error exists activated error exists activated error invalid activated error invalid activated error offline activated error offline deactivated deactivated deactivated error deactivated error deactivated error offline deactivated error offline deactivated error unknown deactivated error unknown parameter placeholder description subscription code the value of the subscription code storefront tab navigation clicked parameter placeholder description action the type of the action of the tapped navigation entry the value is based on the file " navigation json " target the path of the tapped navigation entry the value is based on the file " navigation json " placeholder for ad related events parameter placeholder description ad id the id of the ad placeholder for purchase related events parameter placeholder description currency code the locale based currency code (e g "usd") price the price of the purchased product product id the related product id transaction id the related transaction id from google play store or apple store