URL Parameters

Introduction

URL parameters let you customize and fine-tune the behavior of 3D Showcase.

URL parameters are great when you want the same Matterport Space to behave differently in different places that you share it. By contrast, changes in Workshop change the Matterport Space everywhere you share it

For example you can share the normal, fully-branded version of a home on your company's website, but use a URL parameter to share an MLS-friendly version on an MLS listing site.

 

Add a URL Parameter

Just add the URL parameter to the end of the sharing URL. Then share the link like normal.

https://my.matterport.com/show/?m=uRGXgoiYk9f&help=1

Add as many parameters as you want. The order does not matter.

You can also modify the URL before you embed it in an iframe.

<iframe width='853' height='480' frameborder=0 allowfullscreen src='https://my.matterport.com/show/?m=xxxxxxxxxxx&brand=0&help=1'></iframe>

The m=xxxxxxxxxxx URL parameter identifies the Matterport Space. It is the only URL parameter that is necessary. All other URL parameters are optional. If a URL parameter is not directly specified, the default value is used.

The order of the URL parameters does not matter. Just specify the ? mark first, and then & for additional parameters. For example, the following two URLs are the same:
https://my.matterport.com/show/?m=4pYEangv54B&mls=1
https://my.matterport.com/show/?mls=1&m=4pYEangv54B

 

Table of Contents

  1. Launching 3D Showcase
  2. Visibility
  3. User Interface
  4. Guided Tours
  5. Virtual Reality

 

Launching 3D Showcase

help
null Default Show help for new users (those who have never opened a Matterport Space before).
0   Do not show help at all.
1   Always show help when the Matterport Space opens.
2   Always show help when the Matterport Space opens. More concise help text than &help=1.
https://my.matterport.com/show/?m=Zh14WDtkjdC&help=1
See example help screens.

 

hl
 0  Default if Highlight Reel
does not have a 360º View
Briefly show the Highlight Reel upon launch before hiding.
1 Default if Highlight Reel
does have a 360º View 
Keep the Highlight Reel visible upon launch. 
2   Keeps the Highlight Reel collapsed. This option is only available if there is no 360º View in the Highlight Reel. If there is a 360º View then the &hl=1 behavior will be used. (keep the High
https://my.matterport.com/show/?m=Zh14WDtkjdC&hl=1

 

play
 0  Default Shows a Play button ▶️️  on the iframe. The user must press the Play button ▶️️  to open the Matterport Space.
1   Automatically opens the Matterport Space when the iframe loads on the page. If the 3D Showcase is opened via a link (not embedded in an iframe), this option is chosen automatically.
<iframe width="750" height="422" src="https://my.matterport.com/show/?m=Zh14WDtkjdC&play=1" frameborder="0" allowfullscreen></iframe>

 

qs
 0  Default Disable Quickstart (when the Matterport Space first opens, zoom in from Dollhouse View).
1   Enable Quickstart (when the Matterport Space first opens, go straight into Inside View). Learn more. Only works if Start Position is Inside View.
https://my.matterport.com/show/?m=Zh14WDtkjdC&qs=1

 

ts
<integer> Number of seconds after initial fly-in before the Guided Tour automatically starts. Help is not shown. Set to a negative number to not start the Guided Tour.
https://my.matterport.com/show/?m=Zh14WDtkjdC&ts=5

 

Visibility

brand
 0    Hide 'Presented By' details when Space opens. Hide contact details in the About Panel (top-left grey corner of 3D Showcase).
1 Default Display all branding information in the About Panel (top-left corner of 3D Showcase).
https://my.matterport.com/show/?m=Zh14WDtkjdC&brand=0

 

mls
 0  Default Show branding information, links in Mattertag™ Posts, and VR.
1   Show the MLS-friendly version of the Matterport Space. This removes branding, removes links in Mattertag™ Posts, and removes VR.
2   Same behavior as &mls=1 but also removes the About Panel in the top-left corner after loading.
https://my.matterport.com/show/?m=Zh14WDtkjdC&mls=1

 

User Interface

f
 0    Remove the option to switch floors. This treats the Matterport Space as "all one floor".
1 Default Let the user navigate the Space floor by floor.
https://my.matterport.com/show/?m=cV2xwRC8ghH&f=0

 

lang
 en  Default Shows the 3D Showcase user interface (help, tooltips, terms of service, etc) in American English.
es   Shows the 3D Showcase UI in Spanish.
fr   Shows the 3D Showcase UI in French.
de   Shows the 3D Showcase UI in German.
ru   Shows the 3D Showcase UI in Russian.
https://my.matterport.com/show/?m=Zh14WDtkjdC&lang=es

 

nozoom
 0  Default Enable zooming in 3D Showcase
1   Disable zooming in 3D Showcase
https://my.matterport.com/show/?m=Zh14WDtkjdC&nozoom=1

 

wh
0   Ignore scroll wheel input from the mouse. Scroll wheel input will cause the entire webpage to move up and down. This parameter is only valid when the Space is embedded with an iframe.
 1  Default Enables scroll wheel input from the mouse, so the Space can zoom in. 3D Showcase will only listen to scroll wheel input if the cursor is over the iframe.
<iframe width="750" height="422" src="https://my.matterport.com/show/?m=Zh14WDtkjdC&wh=0" frameborder="0" allowfullscreen></iframe>

 

Guided Tours

Guided Tours are defined as the automatic progression through the Highlight Reel when the user presses the Play button.

guides
 0    Do not show the path to the next highlight.
1 Default For Guided Tours with walkthrough transitions, show the blue path on the ground to the next highlight. 
https://my.matterport.com/show/?m=Zh14WDtkjdC&guides=0

 

kb
 0    Do not pan when you reach a new highlight in a Guided Tour.
1 Default Gently pan once you reach a new highlight in a Guided Tour.
https://my.matterport.com/show/?m=Zh14WDtkjdC&kb=0

 

lp
 0  Default Stop once you reach the end of the Guided Tour.
1   Loop back to the beginning once you reach the end.
https://my.matterport.com/show/?m=Zh14WDtkjdC&lp=1

 

mf
 0    For Guided Tours with walkthrough transitions, use the 3D mesh when transitioning between highlights.
1 Default Use 2D panorama imagery during transitions (mesh-free transitions).
https://my.matterport.com/show/?m=e9oPuyxrEXU&mf=0

 

st
<integer> Number of milliseconds to wait at each highlight during a Guided Tour. Default is 3500 ms.
https://my.matterport.com/show/?m=Zh14WDtkjdC&st=2000

 

title
 0    Space title is not displayed. Top-left about panel not displayed.
1 Default Space title is displayed. Top-left about panel is displayed.
2   Space title is not displayed. Top-left about panel is displayed.
https://my.matterport.com/show/?m=Zh14WDtkjdC&title=2

 

tourcta
 0    No call to action at the end of a a Guided Tour
1 Default Large call to action at the end of a Guided Tour
2   Small call to action at the end of a Guided Tour
https://my.matterport.com/show/?m=Zh14WDtkjdC&tourcta=2

 

Virtual Reality

vr
 0    Hide the VR button.
1 Default Show the VR button.
https://my.matterport.com/show/?m=Zh14WDtkjdC&vr=0

 

vrcoll
Default Opens the Space in the "Shared with Me" folder within the app. Users can navigate to other Spaces in the Matterport VR app.
1   Opens the Space in a limited mode by itself. Users cannot navigate to other Spaces in the Matterport VR app. This is the same limited mode that is used in VR Collections
https://my.matterport.com/show/?m=Zh14WDtkjdC&vrcoll=1
Have more questions? Submit a request