Integration URL parameters
The following table lists the parameters that you can use in an integration URL to launch a Live session:
| Parameter | Description | Value |
|---|---|---|
os |
The operating system (OS) you want to integrate. |
Windows, OS X, Android, iOS, or Winphone.Default: Windows
|
os_version |
The OS version you want to integrate. | Windows: XP, 7, 8, and 8.1. OS X: Lion, Snow Leopard, Mountain Lion, Mavericks, Yosemite. Default: XP for Windows, Snow Leopard for OS X. |
browser (desktop only) |
Browser you want to integrate. |
Firefox, Safari, IE, Chrome, Opera. Default: Firefox
|
browser_version (desktop only) |
Browser version you want to integrate. | View list of browser versions to update this field. Default: 10.0
|
device (mobile only) |
Mobile device you want to integrate. | View list of devices to update this field. Default: 10
|
resolution |
Resolution you want to integrate. |
responsive-mode: Uses entire screen of your browser and accesses any resolution by resizing your browser. Windows (XP, 7): 800x600, 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, 2048x1536 Windows (8,8.1,10): 1024x768, 1280x800, 1280x1024, 1366x768, 1440x900, 1680x1050, 1600x1200, 1920x1200, 1920x1080, 2048x1536OS X: 1024x768, 1280x960, 1280x1024, 1600x1200, 1920x1080 Default: responsive-mode
|
scale_to_fit |
Enable or disable scale to fit mode. |
true or false Default: true
|
speed |
Toggle between fast speed or high quality. |
1 for fast speed, 2 for high quality. Default: 1
|
start |
Enable or disable auto start mode. |
true or false Default: false
|
src |
Unique tracking parameter. | Use a special key for traffic from your source so that we can track it accurately. |
url |
Specify URL to test. | URLs can be of 3 types: Public: e.g. google.com Local folders: Filename that needs to be tested. E.g. test.html Local servers: E.g. http://localhost:3000/sign_up |
In addition to the above parameters, use the following parameters if you want to enable local testing using extensions:
| Parameter | Description | Value |
|---|---|---|
local |
Enable or disable Local Testing. | Mandatorily pass local=true to enable Local Testing. Default: false
|
force-local |
Define whether all URLs, private or public, should be resolved through your network. |
true or false Default: false
|
| Local Testing using Binaries | This parameter works only for browsers which do not support Local Testing extensions. | |
use_cmd_local |
This parameter is useful for browsers that do not support Local Testing browser extensions.. Note: Local Testing using binaries should already be running in order to use this feature.. |
Pass use_cmd_local=true if you specifically want to use the binaries for Local Testing. Default: false |
folder |
Note: Local folder testing with browser extensions via Integrations API is not supported. | If you want to do local folder testing, then specify the absolute path of your directory in following format: Mac: /Users/.. Windows: C:\\Users\\Public..>
|
Related topics
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!