URL parameters are snippets of text added to the end of a URL that let you control the presentation of virtual tour content that you're linking to, or have embedded on your website. Put a different way, URL parameters are like little magic spells that give your virtual tour superpowers 🦸♀️.
Parameters are added following a ? at the end of the link. For example, on the link below, the ?ui=0 portion is known as the URL parameter. In this instance, it's instructing the scene to load without any UI elements.
Here are some common uses for parameters:
Show or hide different interface elements of your virtual tour interface
Send a user to a site that is loaded in a specific language for them
URL Parameters
Name | What it does | Parameter | Notes |
CTA • Hide Button CTAs | Hides all Button Calls to Action | ?ctas=0 | This parameter only suppresses buttons, not Timed CTAs. |
CTA • Hide Timed CTAs | Suppresses all Timed CTAs from displaying—both On Entry and those that fire after the tour splash or a certain number of scenes | ?ctasTimed=0 | Useful when you're sending visitors into your tour from channels like email campaigns, where you already have user information and lead collection is not needed. |
CTA • Open CTA | Opens the CTA in the position # | ?opencta=# | Often used to link into a tour with a form modal that pops up first. Rather than using this, we recommend using "On Entry CTAs" |
Language • Load Language | Load a site in a specific language, if the content exists for that language | ?lng=[LANGUAGE CODE] | Language codes: Arabic: ar Spanish: es French: fr Japanese: ja Korean: ko Portuguese: pt Russian: ru Vietnamese: vi Chinese (Simplified): zh-hans Chinese (Traditional): zh-hant |
UI • Hide Guide Card | Hides the Guide Card on a 360° Scene | ?guidecard=0 |
|
UI • Hide Hotspots | Hides all hotspots on a 360° Scene | ?hotspots=0 |
|
UI • Hide Logo | Hides the logo element | ?logo=0 |
|
UI • Hide Scene Nav | Hides the Scene Nav, limiting users to a single scene (if in the context of a tour) | ?scenenav=0 | We recommend using a scene embed instead of this parameter, to avoid a negative impact on tour metrics. |
UI • Hide UI | Hides all user interface elements, and just shows the 360° panorama media or Gallery media | ?ui=0 |
|
Pro tip: stacking parameters
For even more control over presentation, you can combine multiple parameters by separating them with "&". The "?" symbol only needs to appear before the first parameter.
For example, to remove the logo and Button CTAs on a tour, you can add ?logo=0 and ctas=0 to the URL, separated by "&" which will display as follows:
https://app.madewithcircuit.com/demo/seneca-college/king-campus-aerial-view?logo=0&ctas=0
Language Selection and Parameters
Linking directly to translated sites can be done by appending this parameter and the language code to the URL, like this: https://virtual-tour.executivecentre.com/tec/home/products-services?lng=ja
Without the parameter, Circuit will look up the user's preferences on the browser or device, and see if there's a matching language available. So someone who uses a web browser in Japanese will actually get Japanese first on Circuit (assuming that language is one you've added). The language selector is always visible to allow switching, and the parameter above is good for enforcing a particular language to load first.
💡 Need more help?
Send us a message and we will be happy to assist you.