Request URL

Task can be created using 2 methods:

PUT https://api.dotcom-monitor.com/config_api_v1/tasks
POST  https://api.dotcom-monitor.com/config_api_v1/tasks?verb=PUT

 Header Parameters

Content-Type: application/json
Example PUT/POST Content (formatted) for the HTTP task type
{
    "RequestType": "GET",
    "Url": "http://msn.com",
    "Keyword1": "Entertainment",
    "FullPageDownload": true,
    "Download_Html": true,
    "Download_Frames": true,
    "Download_StyleSheets": true,
    "GetParams": 
    [
        {
            "Name": "variable",
            "Value": "value"
        }
    ],
    "PostParams": [],
    "HeaderParams": [],
    "Device_Id": 8550,
    "Task_Type_Id": 1,
    "Name": "msn.com",
    "Timeout": 0
}

Required Body Parameters

Each Task type contains individual set of fields and values. You can find a detailed description of JSON objects and fields for a specific task type in the related sections:

UserView API

If you need to create an UserView Task that contains Secure Vault variables, use the approach described in API: Create UserView Task.

To find a list of possible values for Task_Type_Id, see Potential Values for Task Type ID.

Generally, the following common fields are required in the request body:

Field

Type

Required/Optional

 Description

Device_Id

int32

required
The unique device id.

Task_Type_Id

int32

required
Type of the task. Please check Potential Values for Task_Type_Id.

Name

string

optional

 Task description. It is recommended to specify a unique description for the task.

Example:
"Name": "new name"

Success Response

Example Response
{
    "Success":true,
    "Result":17989
}
Field

Type

 Description

Result

int32

 The unique id for the task.