Base URL

All URIs referenced in the document have the following base:

https://api.dotcom-monitor.com/config_api_v1/

In this article you can find JSON request and response objects for all type of operations with Custom Collectors and SNMP Counters, detailed fields description and explanatory notes:

Get Registered Counter Information

Request URL

GET https://api.dotcom-monitor.com/config_api_v1/counterinfo/get/{collector_UID}

Returns JSON (META about categories…) that was saved.

Path Parameters

Field Type Required Description
collector_UID

string

true

 The collector ID assigned to the collector. To find the UID value go to Configure > MetricsView Collectors > Edit Collector > Collector ID.

Success Response

{
    "GetCounterInfoResult":"{"results":[
        {
            "CategoryName":"Sample Category 1",
            "InstanceList":[
                "i-01","i-02",
                "_Total",
                "sdd"
            ],
            "CounterList":[
                "c-01",
                "c-02"
            ]
        },
        {
            "CategoryName":"Sample Category 2",
            "InstanceList":[
                "b-01",
                "b-02",
                "_Total"
            ],
            "CounterList":[
                "d-01",
                "d-02"
            ]
        },
        {
            "CategoryName":"S001",
            "InstanceList":null,
            "CounterList":[
                "var–1"
            ]
        }
    ]
    }"
}
Register Counter Info

Request URL

POST https://api.dotcom-monitor.com/config_api_v1/counterinfo/post/{collector_UID}

Path Parameters

Field Type Required Description
collector_UID

string

true

 The collector ID assigned to the collector. To find the UID value go to Configure > MetricsView Collectors > Edit Collector > Collector ID.
Example Post body for Custom Collector
{
    "results": [
        {
            "CategoryName": "Sample Category 1",
            "InstanceList": [
                "i-01",
                "i-02",
                "_Total"
            ],
            "CounterList": [
                "c-01",
                "c-02"
            ]
        },
        {
            "CategoryName": "Sample Category 2",
            "InstanceList": [
                "b-01",
                "b-02",
                "_Total"
            ],
            "CounterList": [
                "d-01",
                "d-02"
            ]
        }
    ]
}
Example Post body for SNMP Counter
{
    "results":
    {
        "OIDs":[
            "Sample OID 1",
            "Sample OID 2"
        ]
    }
}
Get Tasks List

Request URL

GET https://api.dotcom-monitor.com/config_api_v1/tasks/counterinfo/get/{collector_UID}

Returns JSON with task list.

Path Parameters

Field Type Required Description
collector_UID

string

true

 The collector ID assigned to the collector. To find the UID value go to Configure > MetricsView Collectors > Edit Collector > Collector ID.

Success Response

{
    "Sample Task UID 1": "Sample Counter Path 1",
    "Sample Task UID 2": "Sample Counter Path 2"
}
Send Collected Counter Values

Request URL

POST https://api.dotcom-monitor.com/config_api_v1/counterinfo/tasks/post/{collector_UID}

Path Parameters

Field Type Required Description
collector_UID

string

true

 The collector ID assigned to the collector. To find the UID value go to Configure > MetricsView Collectors > Edit Collector > Collector ID.

Example Post Body

{
    "Sample Task UID 1": 2343.44,
    "Sample Task UID 2": 8292
}