SightMap® Query String API

The application can receive configuration via the URL's query string. Listed below are the parameters the application will accept.

Parameter	Description	Default Value	Example Value
unit_number	The prospect-facing identifier for the selected unit.	none	`1-101` or `303`
unit_id	The ID for the selected unit.	none	`123446`
floor_id	The ID for the selected floor.	none	`12346`
display_details	Whether or not to display the Unit Details modal. The value is expected to be either `0` or `1`. Note: This value is only considered if unit_id or unit_number is provided.	`0`	`0` or `1`
move_in_date	Sets the move in date value for the user. The value is expected to be any valid date string format recognized in browsers. We recommend using the ISO 8601 format.	none	`2017-06-20` or `06/20/2017`
lease_term	Sets the lease term value for the user. The value is expected to be a positive, non-zero integer.	none	`9` or `15`
instance	The instance key for a specific SightMap. This a custom value set during implementation. It enables developers to choose which SightMap instance displays on embed loads. This is only applicable if an embed contains multiple SightMap applications and an instance key is set by an Engrain management user.	none	`sightmap1`
oll_*	Enables developers to passthrough query parameters onto the configured "Apply" URL. The `oll_` prefix is stripped before appending the query parameters. Multiple passthrough parameters can be provided. Note: Existing query parameters cannot be overridden. Thus any passthrough query parameter which conflicts with an existing query parameter will be ignored.	none	`oll_utm=Zillow` or `oll_my-param=example`
mode	Sets the mode that the SightMap displays in. The value is expected to be either `general` or `expense_calculator` . Note: This value is only considered if unit_id or unit_number is provided.	`general`	`expense_calculator`


https://sightmap.com/embed/e8ywkqrqwlx?unit_number=738