Python access to Xenon View.
Project description
xenon-view-sdk
The Xenon View Python SDK is the Python SDK to interact with XenonView.
- What's New
- Introduction
- Steps To Get Started
- Detailed Usage
- License
What's New
- v0.1.9 - Added: Abandonment Watchdog Feature, leadAttribution outcome
- v0.1.8 - Added: Term for all subscriptions.
- v0.1.7 - Added: changed value to price.
- v0.1.6 - Added: Downsell, Ad, Content Archive, Subscription Pause and included price for all subscriptions
- v0.1.5 - remove journeys call
- v0.1.4 - Rename tag to variant
- v0.1.3 - Readme update
- v0.1.2 - typo fixed
- v0.1.1 - duplicates for new SDK handled
- v0.1.0 - SDK redesign
Introduction
Everyone should have access to world-class customer telemetry.
You should be able to identify the most pressing problems affecting your business quickly. You should be able to determine if messaging or pricing, or technical challenges are causing friction for your customers. You should be able to answer questions like:
- Is my paywall wording or the price of my subscriptions causing my customers to subscribe less?
- Is my website performance or my application performance driving retention?
- Is purchasing a specific product or the product portfolio driving referrals?
With the correct approach to instrumentation coupled with AI-enhanced analytics, you can quickly answer these questions and much more.
Get Started With The Following Steps:
The Xenon View SDK can be used in your application to provide a new level of customer telemetry. You'll need to embed the instrumentation into your website/application via this SDK.
Instrumentation will vary based on your use case; are you offering a service/subscription (SaaS) or selling products (Ecom)?
In a nutshell, the steps to get started are as follows:
- Identify Business Outcomes and Customer Journey Milestones leading to those Outcomes.
- Instrument the Outcomes/Milestones.
- Analyze the results.
Step 1 - Business Outcomes
Regardless of your business model, your first step will be identifying your desired business outcomes.
Example - Service/Subscription/SaaS:
- Lead Capture
- Account Signup
- Initial Subscription
- Renewed Subscription
- Upsold Subscription
- Referral
Example - Ecom:
- Place the product in the cart
- Checkout
- Upsold
- Purchase
:memo: Note: Each outcome has an associated success and failure.
Step 2 - Customer Journey Milestones
For each Business Outcome, identify potential customer journey milestones leading up to that business outcome.
Example - Service/Subscription/SaaS for Lead Capture:
- View informational content
- Asks question in the forum
- Views FAQs
- Views HowTo
- Requests info product
Example - Ecom for Place product in cart :
- Search for product information
- Learns about product
- Read reviews
Step 3 - Enumerate Technical Stack
Next, you will want to figure out which SDK to use. We have some of the most popular languages covered.
Start by listing the technologies involved and what languages your company uses. For example:
- Front end - UI (Javascript - react)
- Back end - API server (Java)
- Mobile app - iPhone (Swift)
- Mobile app - Android (Android Java)
Next, figure out how your outcomes spread across those technologies. Below are pointers to our currently supported languages:
Finally, continue the steps below for each technology and outcome.
Step 4 - Installation
After you have done the prework of Step 1 and Step 2, you are ready to install Xenon View. Once installed, you'll need to initialize the SDK and get started instrumenting.
Step 5 - Instrument Business Outcomes
We have provided several SDK calls to shortcut your instrumentation and map to the outcomes identified in Step 1.
These calls will roll up into the associated Categories during analysis. These rollups allow you to view each Category in totality.
As you view the categories, you can quickly identify issues (for example, if there are more Failures than Successes for a Category).
Service/Subscription/SaaS Related Outcome Calls (click on a call to see usage)
| Category | Success | Decline |
|---|---|---|
| Lead Attribution | leadAttribution() |
|
| Lead Capture | leadCaptured() |
leadCaptureDeclined() |
| Account Signup | accountSignup() |
accountSignupDeclined() |
| Application Installation | applicationInstalled() |
applicationNotInstalled() |
| Initial Subscription | initialSubscription() |
subscriptionDeclined() |
| Subscription Renewed | subscriptionRenewed() |
subscriptionCanceled() / subscriptionPaused() |
| Subscription Upsell | subscriptionUpsold() |
subscriptionUpsellDeclined() / subscriptionDownsell() |
| Ad Clicked | adClicked() |
adIgnored() |
| Referral | referral() |
referralDeclined() |
Ecom Related Outcome Calls (click on a call to see usage)
| Category | Success | Decline |
|---|---|---|
| Lead Attribution | leadAttribution() |
|
| Lead Capture | leadCaptured() |
leadCaptureDeclined() |
| Account Signup | accountSignup() |
accountSignupDeclined() |
| Add To Cart | productAddedToCart() |
productNotAddedToCart() |
| Product Upsell | upsold() |
upsellDismissed() |
| Checkout | checkedOut() |
checkoutCanceled() / productRemoved() |
| Purchase | purchased() |
purchaseCanceled() |
| Promise Fulfillment | promiseFulfilled() |
promiseUnfulfilled() |
| Product Disposition | productKept() |
productReturned() |
| Referral | referral() |
referralDeclined() |
Step 6 - Instrument Customer Journey Milestones
Next, you will want to instrument your website/application/backend/service for the identified Customer Journey Milestones Step 2. We have provided several SDK calls to shortcut your instrumentation here as well.
During analysis, each Milestone is chained together with the proceeding and following Milestones. That chain terminates with an Outcome (described in Step 4). AI/ML is employed to determine Outcome correlation and predictability for the chains and individual Milestones. During the analysis step, you can view the correlation and predictability as well as the Milestone chains (called Customer Journeys in this guide).
Milestones break down into two types (click on a call to see usage):
| Features | Content |
|---|---|
featureAttempted() |
contentViewed() |
featureFailed() |
contentCreated() / contentEdited() |
featureCompleted() |
contentDeleted() / contentArchived() |
contentRequested()/contentSearched() |
Step 7 - Commit Points
Once instrumented, you'll want to select appropriate commit points. Committing will initiate the analysis on your behalf by Xenon View.
Step 8 (Optional) - Group Customer Journeys
All the customer journeys (milestones and outcomes) are anonymous by default. For example, if a Customer interacts with your brand in the following way:
- Starts on your marketing website.
- Downloads and uses an app.
- Uses a feature requiring an API call.
Each of those journeys will be unconnected and not grouped.
To associate those journeys with each other, you can deanonymize the Customer. Deanonymizing will allow for a deeper analysis of a particular user.
Deanonymizing is optional. Basic matching of the customer journey with outcomes is valuable by itself. Deanonymizing will add increased insight as it connects Customer Journeys across devices.
Step 9 - Analysis
Once you have released your instrumented code, you can head to XenonView to view the analytics.
Step 10 - Perform Experiments
There are multiple ways you can experiment using XenonView. We"ll focus here on three of the most common: time, platform, and variant based cohorts.
Time-based cohorts
Each Outcome and Milestone is timestamped. You can use this during the analysis phase to compare timeframes. A typical example is making a feature change. Knowing when the feature went to production, you can filter in the XenonView UI based on the timeframe before and the timeframe after to observe the results.
Variant-based cohorts
You can identify a journey collection as an experiment before collecting data. This will allow you to run A/B testing-type experiments (of course not limited to two). As an example, let"s say you have two alternate content/feature variants and you have a way to direct half of the users to Variant A and the other half to Variant B. You can name each variant before the section of code that performs that journey. After collecting the data, you can filter in the XenonView UI based on each variant to observe the results.
Platform-based cohorts
You can Platform any journey collection before collecting data. This will allow you to experiment against different platforms:
- Operating System Name
- Operating System version
- Device model (Pixel, iPhone 14, Docker Container, Linux VM, Dell Server, etc.)
- A software version of your application.
As an example, let's say you have an iPhone and Android mobile application and you want to see if an outcome is more successful on one device verse the other. You can platform before the section of code that performs that flow. After collecting the data, you can filter in the XenonView UI based on each platform to observe the results.
Detailed Usage
The following section gives detailed usage instructions and descriptions. It provides code examples for each of the calls.
The SDK supports Python 3+.
Installation
You can install the View Python SDK from PyPI:
pip install xenon-view-sdk
Instantiation
The View SDK is a Python module you'll need to include in your application. After inclusion, you'll need to init the singleton object:
from xenon_view_sdk import Xenon
# start by initializing Xenon View
Xenon('<API KEY>')
-OR-
from xenon_view_sdk import Xenon
# to initialize Xenon View after construction
Xenon('TBD')
Xenon().key('<API KEY>')
Of course, you'll have to make the following modifications to the above code:
- Replace
<API KEY>with your api key
Service/Subscription/SaaS Related Business Outcomes
Lead Attributed
Use this call to track Lead Attribution (Google Ads, Facebook Ads, etc.) You can add a source and identifier string to the call to differentiate as follows:
leadAttributed()
from xenon_view_sdk import Xenon
source = 'Google Ad'
identifier = 'Search'
# Successful Lead Attributed to Google Ad
Xenon().leadAttributed(source)
#...
# Successful Lead Attributed to Google Search Ad
Xenon().leadAttributed(source, identifier)
Lead Capture
Use this call to track Lead Capture (emails, phone numbers, etc.) You can add a specifier string to the call to differentiate as follows:
leadCaptured()
from xenon_view_sdk import Xenon
emailSpecified = "Email"
phoneSpecified = "Phone Number"
# Successful Lead Capture of an email
Xenon().leadCaptured(emailSpecified)
# ...
# Successful Lead Capture of a phone number
Xenon().leadCaptured(phoneSpecified)
leadCaptureDeclined()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
emailSpecified = "Email"
phoneSpecified = "Phone Number"
# Unsuccessful Lead Capture of an email
Xenon().leadCaptureDeclined(emailSpecified)
# ...
# Unsuccessful Lead Capture of a phone number
Xenon().leadCaptureDeclined(phoneSpecified)
Account Signup
Use this call to track when customers signup for an account. You can add a specifier string to the call to differentiate as follows:
accountSignup()
from xenon_view_sdk import Xenon
viaFacebook = "Facebook"
viaGoogle = "Google"
viaEmail = "Email"
# Successful Account Signup with Facebook
Xenon().accountSignup(viaFacebook)
# ...
# Successful Account Signup with Google
Xenon().accountSignup(viaGoogle)
# ...
# Successful Account Signup with an Email
Xenon().accountSignup(viaEmail)
accountSignupDeclined()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
viaFacebook = "Facebook"
viaGoogle = "Google"
viaEmail = "Email"
# Unsuccessful Account Signup with Facebook
Xenon().accountSignupDeclined(viaFacebook)
# ...
# Unsuccessful Account Signup with Google
Xenon().accountSignupDeclined(viaGoogle)
# ...
# Unsuccessful Account Signup with an Email
Xenon().accountSignupDeclined(viaEmail)
Application Installation
Use this call to track when customers install your application.
applicationInstalled()
from xenon_view_sdk import Xenon
# Successful Application Installation
Xenon().applicationInstalled()
applicationNotInstalled()
:memo: Note: You want consistency between success and failure.
from xenon_view_sdk import Xenon
# Unsuccessful or not completed Application Installation
Xenon().applicationNotInstalled()
Initial Subscription
Use this call to track when customers initially subscribe. You can add a specifier string to the call to differentiate as follows:
initialSubscription()
from xenon_view_sdk import Xenon
tierSilver = "Silver Monthly"
tierGold = "Gold"
tierPlatium = "Platium"
annualSilver = "Silver Annual"
method = "Stripe" # optional
price = '$25' #optional
term = "30d" #optional
# Successful subscription of the lowest tier with Stripe
Xenon().initialSubscription(tierSilver, method)
# Successful subscription of the lowest tier with Stripe for $25 for term
Xenon().initialSubscription(tierSilver, method, price, term)
# ...
# Successful subscription to the middle tier
Xenon().initialSubscription(tierGold)
# ...
# Successful subscription to the top tier
Xenon().initialSubscription(tierPlatium)
# ...
# Successful subscription of an annual period
Xenon().initialSubscription(annualSilver)
subscriptionDeclined()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
tierSilver = "Silver Monthly"
tierGold = "Gold"
tierPlatium = "Platium"
annualSilver = "Silver Annual"
method = "Stripe" # optional
price = '$25' # optional
term = "30d" # optional
# Unsuccessful subscription of the lowest tier
Xenon().subscriptionDeclined(tierSilver)
# ...
# Unsuccessful subscription of the middle tier
Xenon().subscriptionDeclined(tierGold)
# ...
# Unsuccessful subscription to the top tier
Xenon().subscriptionDeclined(tierPlatium)
# ...
# Unsuccessful subscription of an annual period with Stripe
Xenon().subscriptionDeclined(annualSilver, method)
# Unsuccessful subscription of an annual period for $25 for term
Xenon().subscriptionDeclined(annualSilver, method, price, term)
Subscription Renewal
Use this call to track when customers renew. You can add a specifier string to the call to differentiate as follows:
subscriptionRenewed()
from xenon_view_sdk import Xenon
tierSilver = "Silver Monthly"
tierGold = "Gold"
tierPlatium = "Platium"
annualSilver = "Silver Annual"
method = "Stripe" #optional
price = '$25' # optional
term = "30d" #optional
# Successful renewal of the lowest tier with Stripe
Xenon().subscriptionRenewed(tierSilver, method)
# Successful renewal of the lowest tier with Stripe for $25 for term
Xenon().subscriptionRenewed(annualSilver, method, price, term)
# ...
# Successful renewal of the middle tier
Xenon().subscriptionRenewed(tierGold)
# ...
# Successful renewal of the top tier
Xenon().subscriptionRenewed(tierPlatium)
# ...
# Successful renewal of an annual period
Xenon().subscriptionRenewed(annualSilver)
subscriptionCanceled()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
tierSilver = "Silver Monthly"
tierGold = "Gold"
tierPlatium = "Platium"
annualSilver = "Silver Annual"
method = "Stripe" #optional
price = '$25' # optional
term = "30d" #optional
# Canceled subscription of the lowest tier
Xenon().subscriptionCanceled(tierSilver)
# ...
# Canceled subscription of the middle tier
Xenon().subscriptionCanceled(tierGold)
# ...
# Canceled subscription of the top tier
Xenon().subscriptionCanceled(tierPlatium)
# ...
# Canceled subscription of an annual period with Stripe
Xenon().subscriptionCanceled(annualSilver, method)
# Canceled subscription of an annual period with Stripe for $25
Xenon().subscriptionCanceled(annualSilver, method, price, term)
subscriptionPaused()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
tierSilver = "Silver Monthly"
tierGold = "Gold"
tierPlatium = "Platium"
annualSilver = "Silver Annual"
method = "Stripe" #optional
price = '$25' # optional
term = "30d" #optional
# Paused subscription of the lowest tier
Xenon().subscriptionPaused(tierSilver)
# ...
# Paused subscription of the middle tier
Xenon().subscriptionPaused(tierGold)
# ...
# Paused subscription of the top tier
Xenon().subscriptionPaused(tierPlatium)
# ...
# Paused subscription of an annual period with Stripe
Xenon().subscriptionPaused(annualSilver, method)
# Paused subscription of an annual period with Stripe for $25 for term
Xenon().subscriptionPaused(annualSilver, method, price, term)
Subscription Upsold
Use this call to track when a Customer upgrades their subscription.
You can add a specifier string to the call to differentiate as follows:
subscriptionUpsold()
from xenon_view_sdk import Xenon
tierGold = "Gold Monthly"
tierPlatium = "Platium"
annualGold = "Gold Annual"
method = "Stripe" #optional
price = '$25' # optional
term = "30d" #optional
# Assume already subscribed to Silver
# Successful upsell of the middle tier with Stripe
Xenon().subscriptionUpsold(tierGold, method)
# Successful upsell of the middle tier with Stripe for $25 for term
Xenon().subscriptionUpsold(tierGold, method, price, term)
# ...
# Successful upsell of the top tier
Xenon().subscriptionUpsold(tierPlatium)
# ...
# Successful upsell of middle tier - annual period
Xenon().subscriptionUpsold(annualGold)
subscriptionUpsellDeclined()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
tierGold = "Gold Monthly"
tierPlatium = "Platium"
annualGold = "Gold Annual"
method = "Stripe" #optional
price = '$25' # optional
term = "30d" #optional
# Assume already subscribed to Silver
# Rejected upsell of the middle tier
Xenon().subscriptionUpsellDeclined(tierGold)
# ...
# Rejected upsell of the top tier
Xenon().subscriptionUpsellDeclined(tierPlatium)
# ...
# Rejected upsell of middle tier - annual period
Xenon().subscriptionUpsellDeclined(annualGold, method)
# Rejected upsell of middle tier - annual period with Stripe for $25 for term
Xenon().subscriptionUpsellDeclined(annualGold, method, price, term)
subscriptionDownsell()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
tierGold = "Gold Monthly"
tierPlatium = "Platium"
annualGold = "Gold Annual"
method = "Stripe" #optional
price = '$15' #optional
term = "30d" #optional
# Assume already subscribed to Platium
# Downsell to Gold
Xenon().subscriptionDownsell(tierGold)
# ...
# Downsell to Gold annual with method
Xenon().subscriptionDownsell(annualGold, method)
# Downsell to Gold - annual period with Stripe for $15 for term
Xenon().subscriptionDownsell(annualGold, method, price, term)
Ad Clicked
Use this call to track when customers click on an Advertisement. You can add a specifier string to the call to differentiate as follows:
adClicked()
from xenon_view_sdk import Xenon
provider = "AdMob"
id = "ID-1234" # optional
price = "$0.25" # optional
# Click an Ad from AdMob
Xenon().adClicked(provider)
# ...
# Click an Ad from AdMob identfied by ID-1234
Xenon().adClicked(provider, id)
# ...
# Click an Ad from AdMob identfied by ID-1234 with price
Xenon().adClicked(provider, id, price)
adIgnored()
from xenon_view_sdk import Xenon
provider = "AdMob"
id = "ID-1234" # optional
price = "$0.25" # optional
# No action on an Ad from AdMob
Xenon().adIgnored(provider)
# ...
# No action on an Ad from AdMob identfied by ID-1234
Xenon().adIgnored(provider, id)
# ...
# No action on an Ad from AdMob identfied by ID-1234 with price
Xenon().adIgnored(provider, id, price)
Referral
Use this call to track when customers refer someone to your offering. You can add a specifier string to the call to differentiate as follows:
referral()
from xenon_view_sdk import Xenon
kind = "Share"
detail = "Review" #optional
# Successful referral by sharing a review
Xenon().referral(kind, detail)
# -OR-
Xenon().referral(kind)
referralDeclined()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
kind = "Share"
detail = "Review" #optional
# Customer declined referral
Xenon().referralDeclined(kind, detail)
# -OR-
Xenon().referralDeclined(kind)
Ecommerce Related Outcomes
Lead Attributed
Use this call to track Lead Attribution (Google Ads, Facebook Ads, etc.) You can add a source and identifier string to the call to differentiate as follows:
leadAttributed()
from xenon_view_sdk import Xenon
source = 'Google Ad'
identifier = 'Search'
# Successful Lead Attributed to Google Ad
Xenon().leadAttributed(source)
#...
# Successful Lead Attributed to Google Search Ad
Xenon().leadAttributed(source, identifier)
Lead Capture
Use this call to track Lead Capture (emails, phone numbers, etc.) You can add a specifier string to the call to differentiate as follows:
leadCaptured()
from xenon_view_sdk import Xenon
emailSpecified = "Email"
phoneSpecified = "Phone Number"
# Successful Lead Capture of an email
Xenon().leadCaptured(emailSpecified)
# ...
# Successful Lead Capture of a phone number
Xenon().leadCaptured(phoneSpecified)
leadCaptureDeclined()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
emailSpecified = "Email"
phoneSpecified = "Phone Number"
# Unsuccessful Lead Capture of an email
Xenon().leadCaptureDeclined(emailSpecified)
# ...
# Unsuccessful Lead Capture of a phone number
Xenon().leadCaptureDeclined(phoneSpecified)
Account Signup
Use this call to track when customers signup for an account. You can add a specifier string to the call to differentiate as follows:
accountSignup()
from xenon_view_sdk import Xenon
viaFacebook = "Facebook"
viaGoogle = "Facebook"
viaEmail = "Email"
# Successful Account Signup with Facebook
Xenon().accountSignup(viaFacebook)
# ...
# Successful Account Signup with Google
Xenon().accountSignup(viaGoogle)
# ...
# Successful Account Signup with an Email
Xenon().accountSignup(viaEmail)
accountSignupDeclined()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
viaFacebook = "Facebook"
viaGoogle = "Facebook"
viaEmail = "Email"
# Unsuccessful Account Signup with Facebook
Xenon().accountSignupDeclined(viaFacebook)
# ...
# Unsuccessful Account Signup with Google
Xenon().accountSignupDeclined(viaGoogle)
# ...
# Unsuccessful Account Signup with an Email
Xenon().accountSignupDeclined(viaEmail)
Add Product To Cart
Use this call to track when customers add a product to the cart. You can add a specifier string to the call to differentiate as follows:
productAddedToCart()
from xenon_view_sdk import Xenon
laptop = "Dell XPS"
keyboard = "Apple Magic Keyboard"
# Successful adds a laptop to the cart
Xenon().productAddedToCart(laptop)
# ...
# Successful adds a keyboard to the cart
Xenon().productAddedToCart(keyboard)
productNotAddedToCart()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
laptop = "Dell XPS"
keyboard = "Apple Magic Keyboard"
# Doesn't add a laptop to the cart
Xenon().productNotAddedToCart(laptop)
# ...
# Doesn't add a keyboard to the cart
Xenon().productNotAddedToCart(keyboard)
Upsold Additional Products
Use this call to track when you upsell additional product(s) to customers. You can add a specifier string to the call to differentiate as follows:
upsold()
from xenon_view_sdk import Xenon
laptop = 'Dell XPS'
laptopValue = '$1459' #optional
keyboard = 'Apple Magic Keyboard'
keyboardValue = '$139' #optional
# upsold a laptop
Xenon().upsold(laptop)
# ...
# upsold a keyboard with price
Xenon().upsold(keyboard, keyboardValue)
upsellDismissed()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
laptop = 'Dell XPS'
keyboard = 'Apple Magic Keyboard'
keyboardValue = '$139' #optional
# Doesn't add a laptop during upsell
Xenon().upsellDismissed(laptop)
# ...
# Doesn't add a keyboard during upsell
Xenon().upsellDismissed(keyboard, keyboardValue)
Customer Checks Out
Use this call to track when your Customer is checking out.
checkedOut()
from xenon_view_sdk import Xenon
# Successful Checkout
Xenon().checkedOut()
checkoutCanceled()
from xenon_view_sdk import Xenon
# Customer cancels check out.
Xenon().checkoutCanceled()
productRemoved()
from xenon_view_sdk import Xenon
laptop = "Dell XPS"
keyboard = "Apple Magic Keyboard"
# Removes a laptop during checkout
Xenon().productRemoved(laptop)
# ...
# Removes a keyboard during checkout
Xenon().productRemoved(keyboard)
Customer Completes Purchase
Use this call to track when your Customer completes a purchase.
purchased()
from xenon_view_sdk import Xenon
method = "Stripe"
price = '$2011' # optional
# Successful Purchase
Xenon().purchased(method)
# Successful Purchase for $2011
Xenon().purchased(method, price)
purchaseCanceled()
from xenon_view_sdk import Xenon
method = "Stripe" #optional
price = '$2011' # optional
# Customer cancels the purchase.
Xenon().purchaseCanceled()
# -OR-
Xenon().purchaseCanceled(method)
# -OR-
Xenon().purchaseCanceled(method, price)
Purchase Shipping
Use this call to track when your Customer receives a purchase.
promiseFulfilled()
from xenon_view_sdk import Xenon
# Successfully Delivered Purchase
Xenon().promiseFulfilled()
promiseUnfulfilled(()
from xenon_view_sdk import Xenon
# Problem Occurs During Shipping And No Delivery
Xenon().promiseUnfulfilled()
Customer Keeps or Returns Product
Use this call to track if your Customer keeps the product. You can add a specifier string to the call to differentiate as follows:
productKept()
from xenon_view_sdk import Xenon
laptop = "Dell XPS"
keyboard = "Apple Magic Keyboard"
# Customer keeps a laptop
Xenon().productKept(laptop)
# ...
# Customer keeps a keyboard
Xenon().productKept(keyboard)
productReturned()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
laptop = "Dell XPS"
keyboard = "Apple Magic Keyboard"
# Customer returns a laptop
Xenon().productReturned(laptop)
# ...
# Customer returns a keyboard
Xenon().productReturned(keyboard)
Referrals
Use this call to track when customers refer someone to your offering. You can add a specifier string to the call to differentiate as follows:
referral()
from xenon_view_sdk import Xenon
kind = "Share Product"
detail = "Dell XPS"
# Successful referral by sharing a laptop
Xenon().referral(kind, detail)
referralDeclined()
:memo: Note: You want to be consistent between success and failure and match the specifiers
from xenon_view_sdk import Xenon
kind = "Share Product"
detail = "Dell XPS"
# Customer declined referral
Xenon().referralDeclined(kind, detail)
Customer Journey Milestones
As a customer interacts with your brand (via Advertisements, Marketing Website, Product/Service, etc.), they journey through a hierarchy of interactions. At the top level are business outcomes. In between Outcomes, they may achieve other milestones, such as interacting with content and features. Proper instrumentation of these milestones can establish correlation and predictability of business outcomes.
As of right now, Customer Journey Milestones break down into two categories:
Feature Usage
Features are your product/application/service's traits or attributes that deliver value to your customers. They differentiate your offering in the market. Typically, they are made up of and implemented by functions.
featureAttempted()
Use this function to indicate the start of feature usage.
from xenon_view_sdk import Xenon
name = "Scale Recipe"
detail = "x2" # optional
# Customer initiated using a feature
Xenon().featureAttempted(name, detail)
# -OR-
Xenon().featureAttempted(name)
featureCompleted()
Use this function to indicate the successful completion of the feature.
from xenon_view_sdk import Xenon
name = "Scale Recipe"
detail = "x2" # optional
# ...
# Customer used a feature
Xenon().featureCompleted(name)
# -OR-
# Customer initiated using a feature
Xenon().featureAttempted(name, detail)
# ...
# feature code/function calls
# ...
# feature completes successfully
Xenon().featureCompleted(name, detail)
# -OR-
Xenon().featureCompleted(name)
featureFailed()
Use this function to indicate the unsuccessful completion of a feature being used (often in the exception handler).
from xenon_view_sdk import Xenon
name = "Scale Recipe"
detail = "x2" # optional
# Customer initiated using a feature
Xenon().featureAttempted(name, detail)
try:
# feature code that could fail
except Exception as e:
# feature completes unsuccessfully
Xenon().featureFailed(name, detail)
# -OR-
Xenon().featureFailed(name)
Content Interaction
Content is created assets/resources for your site/service/product. It can be static or dynamic. You will want to mark content that contributes to your Customer's experience or buying decision. Typical examples:
- Blog
- Blog posts
- Video assets
- Comments
- Reviews
- HowTo Guides
- Charts/Graphs
- Product/Service Descriptions
- Surveys
- Informational product
contentViewed()
Use this function to indicate a view of specific content.
from xenon_view_sdk import Xenon
contentType = "Blog Post"
identifier = "how-to-install-xenon-view" # optional
# Customer view a blog post
Xenon().contentViewed(contentType, identifier)
# -OR-
Xenon().contentViewed(contentType)
contentEdited()
Use this function to indicate the editing of specific content.
from xenon_view_sdk import Xenon
contentType = "Review"
identifier = "Dell XPS" # optional
detail = "Rewrote" # optional
# Customer edited their review about a laptop
Xenon().contentEdited(contentType, identifier, detail)
# -OR-
Xenon().contentEdited(contentType, identifier)
# -OR-
Xenon().contentEdited(contentType)
contentCreated()
Use this function to indicate the creation of specific content.
from xenon_view_sdk import Xenon
contentType = "Blog Comment"
identifier = "how-to-install-xenon-view" # optional
# Customer wrote a comment on a blog post
Xenon().contentCreated(contentType, identifier)
# -OR-
Xenon().contentCreated(contentType)
contentDeleted()
Use this function to indicate the deletion of specific content.
from xenon_view_sdk import Xenon
contentType = "Blog Comment"
identifier = "how-to-install-xenon-view" # optional
# Customer deleted their comment on a blog post
Xenon().contentDeleted(contentType, identifier)
# -OR-
Xenon().contentDeleted(contentType)
contentArchived()
Use this function to indicate archiving specific content.
from xenon_view_sdk import Xenon
contentType = "Blog Comment"
identifier = "how-to-install-xenon-view" # optional
# Customer archived their comment on a blog post
Xenon().contentArchived(contentType, identifier)
# -OR-
Xenon().contentArchived(contentType)
contentRequested()
Use this function to indicate the request for specific content.
from xenon_view_sdk import Xenon
contentType = "Info Product"
identifier = "how-to-efficiently-use-google-ads" # optional
# Customer requested some content
Xenon().contentRequested(contentType, identifier)
# -OR-
Xenon().contentRequested(contentType)
contentSearched()
Use this function to indicate when a user searches.
from xenon_view_sdk import Xenon
contentType = "Info Product"
# Customer searched for some content
Xenon().contentSearched(contentType)
Commit Points
Business Outcomes and Customer Journey Milestones are tracked locally in memory until you commit them to the Xenon View system. After you have created (by either calling a milestone or outcome) a customer journey, you can commit it to Xenon View for analysis as follows:
commit()
from xenon_view_sdk import Xenon
# you can commit a journey to Xenon View
Xenon().commit()
This call commits a customer journey to Xenon View for analysis.
Heartbeats
Business Outcomes and Customer Journey Milestones are tracked locally in memory until you commit them to the Xenon View system. You can use the heartbeat call if you want to commit in batch.
The heartbeat call will update a last-seen metric for customer journeys that have yet to arrive at Business Outcome. The last-seen metric is useful when analyzing stalled Customer Journeys.
Usage is as follows:
heartbeat()
from xenon_view_sdk import Xenon
# you can heartbeat to Xenon View
Xenon().heartbeat()
This call commits any uncommitted journeys to Xenon View for analysis and updates the last accessed time.
:memo: Note: Optionally, you can set abandonment timers via the watchdog parameter. This will allow you to indicate the failed to reach outcomes if no activity is recorded before a specified timeout.
Usage is as follows:
heartbeat(watchdog={params})
from xenon_view_sdk import Xenon
# you can set up an abandonment watchdog
Xenon().heartbeat(watchdog={
'if_abandoned': {
'superOutcome': 'Checkout',
'outcome': 'abandoned',
'result': 'fail'
},
'expires_in_seconds': 600, #10-mins
})
# you can remove an active watchdog
Xenon().heartbeat(watchdog={
'remove': True
})
Platforming
After you have initialized Xenon View, you can optionally specify platform details such as:
- Operating System Name
- Operating System version
- Device model (Pixel, Docker Container, Linux VM, Dell Server, etc.)
- A software version of your application.
platform()
from xenon_view_sdk import Xenon
softwareVersion = "5.1.5"
deviceModel = "Pixel 4 XL"
operatingSystemVersion = "12.0"
operatingSystemName = "Android"
# you can add platform details to outcomes
Xenon().platform(softwareVersion, deviceModel, operatingSystemName, operatingSystemVersion)
This adds platform details for each outcome (Saas/Ecom). Typically, this would be set once at initialization:
from xenon_view_sdk import Xenon
Xenon().init('<API KEY>')
softwareVersion = "5.1.5"
deviceModel = "Pixel 4 XL"
operatingSystemVersion = "12.0"
operatingSystemName = "Android"
Xenon().platform(softwareVersion, deviceModel, operatingSystemName, operatingSystemVersion)
Experiments
After you have initialized Xenon View, you can optionally name variants of customer journeys. Named variants facilitate running experiments such as A/B or split testing.
:memo: Note: You are not limited to just 2 (A or B); there can be many. Additionally, you can have multiple variant names.
variant()
from xenon_view_sdk import Xenon
variant = "subscription-variant-A"
# you can add variant details to outcomes
Xenon().variant([variant])
This adds variant names to each outcome while the variant in play (Saas/Ecom). Typically, you would name a variant once you know the active experiment for this Customer:
from xenon_view_sdk import Xenon
Xenon().init('<API KEY>')
experimentName = getExperiment()
Xenon().variant([experimentName])
resetVariants()
from xenon_view_sdk import Xenon
# you can clear all variant names with the resetVariants method
Xenon().resetVariants()
Customer Journey Grouping
Xenon View supports both anonymous and grouped (known) journeys.
All the customer journeys (milestones and outcomes) are anonymous by default. For example, if a Customer interacts with your brand in the following way:
- Starts on your marketing website.
- Downloads and uses an app.
- Uses a feature requiring an API call.
Each of those journeys will be unconnected and not grouped.
To associate those journeys with each other, you can use deanonymize(). Deanonymizing will allow for a deeper analysis of a particular user.
Deanonymizing is optional. Basic matching of the customer journey with outcomes is valuable by itself. Deanonymizing will add increased insight as it connects Customer Journeys across devices.
Usage is as follows:
deanonymize()
from xenon_view_sdk import Xenon
# you can deanonymize before or after you have committed the journey (in this case, after):
person = {
'name': 'Python Testing',
'email': 'pytest@example.com'
}
Xenon().deanonymize(person)
# you can also deanonymize with a user ID:
person = {
'UUID': "<some unique ID>"
}
Xenon().deanonymize(person)
This call deanonymizes every journey committed to a particular user.
:memo: Note: With journeys that span multiple platforms (e.g., Website->Android->API backend), you can group the Customer Journeys by deanonymizing each.
Other Operations
There are various other operations that you might find helpful:
Error handling
In the event of an API error, an exception occurs with the response from the API as Requests response object:
:memo: Note: The default handling of this situation will restore the journey (appending newly added pageViews, events, etc.) for future committing. If you want to do something special, you can do so like this:
from xenon_view_sdk import Xenon, ApiException
try:
Xenon().commit()
except ApiException as e:
print(str(e.apiResponse().status_code))
Custom Milestones
You can add custom milestones if you need more than the current Customer Journey Milestones.
milestone()
from xenon_view_sdk import Xenon
# you can add a custom milestone to the customer journey
category = "Function"
operation = "Called"
name = "Query Database"
detail = "User Lookup"
Xenon().milestone(category, operation, name, detail)
This call adds a custom milestone to the customer journey.
Journey IDs
Each Customer Journey has an ID akin to a session. After committing an Outcome, the ID remains the same to link all the Journeys. If you have a previous Customer Journey in progress and would like to append to that, you can get/set the ID.
:memo: Note: For Python, the Xenon object is a singleton. Subsequent Outcomes for multiple threads or async operations will reuse the Journey ID.
After you have initialized the Xenon singleton, you can:
- Use the default UUID
- Set the Customer Journey (Session) ID
- Regenerate a new UUID
- Retrieve the Customer Journey (Session) ID
id()
from xenon_view_sdk import Xenon
# by default has Journey ID
print(str(Xenon().id()))
# you can also set the id
testId = '<some random uuid>'
Xenon().id(testId)
assert Xenon().id() == testId
# Lastly, you can generate a new Journey ID (useful for serialized async operations that are for different customers)
Xenon().newId()
License
Apache Version 2.0
See LICENSE
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for xenon_view_sdk-0.1.9-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4921d346c8af6d7fb50c332f76e2e067d5bca92a96c074e69487da0a4095a95b |
|
| MD5 | 0e960b49aef813de3b35b58ca7ae92f2 |
|
| BLAKE2b-256 | 0ae5115863b351a4cf073d84137ec76b61cbf05914f506f7bc8d8fa2ea33ad4a |
