Installation Testing / Debugging
This article covers testing whether Appcues scripts are properly implemented on your site. It includes:
- How to open the Appcues debugger
- Is Appcues installed on the current page?
- Are page changes being tracked?
- Are users being identified?
- What User Properties are being sent to Appcues?
- Why is/isn't a flow showing?
- What if I'm running into an Ad Blocker?
Using the Appcues Debugger
The Appcues debugger is our most straightforward troubleshooting feature. It allows you to quickly spot the root of a problem, so you can get things working again fast.
Opening the debugger from the Chrome Extension
If you're on the URL where your flow(s) should be showing, and you've already downloaded the Chrome extension, you can right-click the Appcues Chrome Extension icon and choose "Debug flows on this page..."
Please note: The debugger will not show the correct results if the builder is open. If the builder does get accidentally opened, not to worry. Simply close the browser window, navigate to the URL where the flow should show in a new window, and try the steps above again.
Opening the debugger from the console
To open your console use the appropriate shortcut below.
Once your console is open, you'll enter in Appcues.debug() in the open spot and hit enter to bring up the debugger.
Note: you may need to scroll down the bottom of the console log to see the space to enter the call
Now that you've got it up you can also use it to Get to the Flow Diagnostics.
Is Appcues installed on the current page?
The easiest test is to try Opening the Appcues Debugger.
If you can't open the debugger you're likely not installed. See the Installation Overview on how to install or send an email to firstname.lastname@example.org if you have already tried installing.
Are page changes being tracked?
As you navigate through your app, the debugger will watch for URL changes and show whether Appcues has checked each one. If the URL changes without Appcues being re-initialized, it will show the last URL that was checked.
To check that things are working, navigate through your app or refresh your page. If the red X next to "Last Tracked URL" persists, Appcues is not tracking page changes. This could signal an issue with the
Appcues.page() call. Select your platform type here to learn how you can install this call.
ProTip: Publish a flow to just your user_ID, targeting the page you're on and see if the flow shows automatically. If you need to refresh the page in order for Appcues to appear, that indicates the Appcuest.page call is in the wrong place.
Are users being identified?
You can see if the user has been identified during the current visit and how many properties were passed in the identify call. If the user properties are being sent correctly you will see a green ✔️.
Clicking on "Details" will show all user properties that were sent at the moment for that user. A red X next to "User Identification" means that we cannot recognize a user on your page. If this is the case, you'll need to add either the
Appcues.anonymous() or both calls to your installation. Learn more about the Appcues.identify() call here.
If you have Appcues installed via Segment, you'll want to make sure Segment's
analytics.identify() call is being called on this page so Appcues can recognize your individual users. Learn more about Segment's identify call here.
What User Properties are being sent to Appcues?
In the same section as "User Identified" (covered above), you can scroll through all user properties for the specific user (probably you) that is logged into that page at the moment.
A full set of User Properties is available on the Events and Properties page in Settings.
Why is/isn't a flow showing?
If a flow is showing, you will see the name of the flow along with and give you details about the group and step.
If you see 'Content Omitted' that means there is a flow that should be showing but isn't for some reason. If you expect a flow to appear, but it does not appear in the Content Omitted group, select the 'View Flow Eligibility' icon to be taken to the Flow Diagnostics page for more information.
If you notice that a step is omitted due to 'dynamic elements' or 'selectors', this can be an indication that the flow is waiting for something to appear on the page (this could be normal) before progressing, or that you should review the current step's selector to ensure that its unique and valid. Learn more about picking the right selector here.
If you've confirmed the above but you still have questions, feel free to reach out to us at email@example.com and we'd be happy to assist!
What if I'm running into an Ad Blocker?
If you're running into issues with ad blockers, consider hosting the Appcues SDK under your own domain (you may need developer's help for this).