To create a BrowserView Task object or change the data on an object that already exists, use the descriptions of the BrowserView Task object fields provided in this article. Any keys you don’t specify will be set to default or remain unchanged (in case of update), so you can specify or update just a subset of the object’s data.

Sample JSON Object
{
    "Timeout": 0,
    "Url": "http://yahoo.com",
    "Keyword1": "news",
    "User": "",
    "Password": "",
    "NetworkFilter": [],
    "CheckCertificate": true,
    "Browser": "Chrome",
    "NetworkTimesOnly": false,
    "DNSResolveMode": "TTL Cached",
    "DNSserverIP": "",
    "CustomDNSHosts": null,
    "IsReturnedVisitor": false,
    "GetVideoEveryRun": false,
    "MinPageReadTimeMs": 0,
    "MaxPageReadTimeMs": 0,
    "ResponseTimeCalculation": "Full Page Load",
    "Device_Id": 269875,
    "Id": 488600,
    "Task_Type_Id": 22,
    "Name": "yahoo"
}

Fields Description

Field Type Required/Optional Description
URL

string

required

 Specifies a destination address. The URL must starts with HTTP:// or HTTPS:// .

Example:
"Url": "http://msn.com"
Keyword1

string

optional

 Keyword search field.

Example:
"Keyword1": "Terms"
User

string

optional

 This field contains a username for HTTP basic access authentication.

Example:
"UserName": "username"
Password

string

optional

 This field contains a password for HTTP basic access authentication.

Example:
"UserPass": "password"
NetworkFilter

Two-dimensional array containing strings

optional

 If you don’t want to download some elements e.g. images, flash, css or may be filter out elements that came with error you should enable network filter and add filter rule.

If you don’t want to use filtering, just leave empty quotes.

Before apply be sure that your root HTML element isn’t filtered.
Example:
"NetworkFilter":
[
["ignore", "ending", "pattern_3"],
["download", "starting", "pattern_4"],
["download", "ending", "pattern_5"] ],
CheckCertificate

boolean

optional

 When enabled – certificates issues will be revealed.

Example:
"CheckCertificate": false
Browser

string

required

 This Field defines which engine has to be emulated during monitoring.

POSSIBLE VALUES: “Chrome”, “Edge”, “Firefox”.

Example:
"Browser": "FireFox"
DisableHttpProxy

boolean

optional

 Allows to activate the proxy to send monitoring requests through a proxy or switch back to direct requests.
DisableVideoRecording

boolean

optional

 Allows to disable the video recording feature.
DisableScreenshots

boolean

optional

 Allows to disable the screenshots feature.
NetworkTimesOnly

boolean

optional

 This feature ignores time taken by browser to render and process events such as rendering, java script execution etc. It is useful only if you are interested in pure server response and download time of the page elements.

Example:
"NetworkTimesOnly": false
DNSResolveMode string optional POSSIBLE VALUES:

  • Device Cached
  • Non Cached
  • TTL Cached
  • External DNS Server

For detailed explanation, see the DNS Mode Option article.
DNSserverIP string optional The field for a custom DNS server IP address. For detailed explanation, see the DNS Mode Option article.
Device_Id

int32

required

 READ ONLY Field. The unique device id.

Example:
"Device_Id": 8692
Id

int32

required

*Only for edit operations

 READ ONLY Field. The unique task id. Do not use for create operations.

Example:
"Id": 18016
Task_Type_Id

int32

required

 The type of the task.

Example:
"Task_Type_Id": 62
Name

string

optional

 The name of the task.

Example:
"Name": "BrowserView task"
Timeout

int32

optional

 This field defines maximum time value (in seconds) for task execution.

Example:
"Timeout": 100