Custom Collector task object in formatted JSON
{
    "Task_UID": "c7c6ffb9bae54df1b662fffb72964c77",
    "Agent_UID": "a06c2dd16de44abea9fad13625c39351",
    "PerformanceCounterPath": "..\\SamCat III\\e-010\\CPU-X",
    "Aggregate": "Average",
    "MaxThreshold": 0,
    "MinThreshold": 0,
    "IgnoreErrors": "NO",
    "Device_Id": 7647,
    "Id": 16532,
    "Task_Type_Id": 26,
    "Name": "..\\SamCat III\\e-010\\CPU-X"
}

Fields Description 

Field Type Required/Optional Description
Task_UID

String

optional

 READ ONLY. Unique Task ID used by API to distribute gathered monitoring results.

Example:
"Task_UID": "c7c6ffb9bae54df1b662fffb72964c77"
Agent_UID

String

required

  Collector UID. Messages containing any statistical value (statistical data should be presented in in numerical terms the floating-point) are received by  “Custom Collector” and then “distributed” to underlying Tasks.

Each Collector has  unique UID. This UID is used afterwards to address counter’ data flow to the exact collector using MetricsView API interface. UID Can be regereated at Collector’s Edit page ( “Downloads” –> “Metricsview” –> “Edit” button) 
Example:
"Agent_UID": "a06c2dd16de44abea9fad13625c39351"
PerformanceCounterPath

String

required

 Descriptive field. It describes monitored object at client side. Value of this field interconnected with underlying fields “Host”, “Category”, “Instance” and “Counter”.

Example:
"PerformanceCounterPath": "..\\SamCat III\\e-010\\CPU-X"
Aggregate

String

required

 All received data will be aggregated on a regular basis, according to the adjusted device frequency.

  • Maximum – the highest value from array will be taken
  • Average – value is calculated as an average of all intermediate values
  • Minimum – the lowest value from array will be taken.
Example:
"Aggregate": "Minimum"
MaxThreshold

int32

optional

 Threshold. Exceeding will result alerting.

Example:
"MaxThreshold": 0
MinThreshold

in32

optional

 Threshold. Exceeding will result alerting.

Example:
"MinThreshold": 0
IgnoreErrors

String

required

*”NO” value is required

  NOT SUPPORTED UNDER CUSTOM COLLECTOR
Device_Id

int32

required

 READ ONLY Field. Unique device id.

Example:
"Device_Id": 7647
Id int32

required

*Only for edit operations

 READ ONLY Field. Unique task id.

Example:
"Id": 16532
Task_Type_Id int32 required Type of the task field. Please check Potential values for “Task_type_id” in appropriate table

Example:
"Task_Type_Id": 26
Name

String

optional

 Task name.

Example:
"Name": "anynameyouwant"