Request URL

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

Returns list of all available platforms.

Success Response

If the request succeeds, the server responds with an HTTP status code and the list of all available platforms. Use these fields to specify information about platforms and packages in your API requests.

Example response
[
    {
        "Id": 1,
        "Name": "ServerView",
        "Packages": [
            {
                "Package_Id": 52,
                "Package_Name": "Platinum 1000",
                "Platform_Id": 1
            }
        ],
        "Available": true
    },
    {
        "Id": 2,
        "Name": "LoadView",
        "Packages": [
            {
                "Package_Id": 122,
                "Package_Name": "On Demand",
                "Platform_Id": 2
            }
        ],
        "Available": true
    },
    {
        "Id": 3,
        "Name": "MetricsView",
        "Packages": [
            {
                "Package_Id": 96,
                "Package_Name": "Platinum 200",
                "Platform_Id": 3
            }
        ],
        "Available": true
    },
    {
        "Id": 4,
        "Name": "UserView",
        "Packages": [
            {
                "Package_Id": 121,
                "Package_Name": "Platinum 200",
                "Platform_Id": 4
            }
        ],
        "Available": true
    },
    {
        "Id": 7,
        "Name": "BrowserView",
        "Packages": [
            {
                "Package_Id": 155,
                "Package_Name": "Platinum 200",
                "Platform_Id": 7
            }
        ],
        "Available": true
    },
    {
        "Id": 8,
        "Name": "MetricsCollector",
        "Packages": [
            {
                "Package_Id": 337,
                "Package_Name": "MV-Agent-10",
                "Platform_Id": 8
            }
        ],
        "Available": true
    },
    {
        "Id": 12,
        "Name": "WebView",
        "Packages": [
            {
                "Package_Id": 465,
                "Package_Name": "Platinum 2000",
                "Platform_Id": 12
            }
        ],
        "Available": true
    },
    {
        "Id": 20,
        "Name": "WebTools",
        "Packages": [
            {
                "Package_Id": 528,
                "Package_Name": "Starter",
                "Platform_Id": 20
            }
        ],
        "Available": true
    }
]

 

Fields Description

Field Type Description

Id

int32

Id equals Platform_Id.

All devices are distributed by 5 platforms. Each platform has its own Platform_Id.

Potential values for Id:
Platform name ID
BrowserView 7
MetricsView 3
ServerView 1
WebView 12
UserView 4
IMPORTANT: UserView scripts can be recorded only with EveryStep Scripting Tool. However, with the Dotcom-Monitor API you can edit an existed UserView task or create a new UserView monitoring task based on a script recorded with EveryStep Scripting Tool.
Example:
"Id": 7
Name string Monitoring Platform Name.

Example:
"Name":"BrowserView"
Packages  array List of packages available within the monitoring platform. For more information, please check our Price Matrix for an exact platform at www.dotcom-monitot.com.
Package_Id int32 The unique id of the package.
Package_Name string Reflects a package name.