{ "opencollection": "1.0.0", "info": { "name": "Catchpoint REST API v2.0 Account NodeUtilization API", "version": "2.0" }, "items": [ { "info": { "name": "NodeUtilization", "type": "folder" }, "items": [ { "info": { "name": "Returns the list of all tests that ran on a node based on Node ID.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/nodes/testrun/:nodeId", "params": [ { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "startTimeUtc", "value": "", "type": "query", "description": "Start time in UTC (YYYY-MM-DDThh:mm:ss)" }, { "name": "endTimeUtc", "value": "", "type": "query", "description": "End time in UTC (YYYY-MM-DDThh:mm:ss)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*[Analytics Endpoint]*\r\n \r\nWorks only on Enterprise Nodes.\r\n \r\nThe maximum time range allowed is 1 hour. When no time range is provided, last 1 hour test runs are returned." }, { "info": { "name": "Returns the node run rate and slippage information based on Node ID.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/nodes/runrate/:nodeId", "params": [ { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "startTimeUtc", "value": "", "type": "query", "description": "Start time in UTC (YYYY-MM-DDThh:mm:ss)" }, { "name": "endTimeUtc", "value": "", "type": "query", "description": "End time in UTC (YYYY-MM-DDThh:mm:ss)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Works only on Enterprise Nodes.\r\n \r\nThe maximum time range allowed is 7 days over the period of last 365 days. If no time range is provided, last 1 hour of data is returned." }, { "info": { "name": "Returns the node capacity utilization percentage based on Node ID.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/nodes/capacityutilization/:nodeId", "params": [ { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "startTimeUtc", "value": "", "type": "query", "description": "Start time in UTC (YYYY-MM-DDThh:mm:ss)" }, { "name": "endTimeUtc", "value": "", "type": "query", "description": "End time in UTC (YYYY-MM-DDThh:mm:ss)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Works only on Enterprise Nodes.\r\n \r\nThe maximum time range allowed is 7 days over the period of last 365 days. If no time range is provided, last 24-hour data is returned." }, { "info": { "name": "Returns the error count details based on Node ID.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/nodes/errors/:nodeId", "params": [ { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "startTimeUtc", "value": "", "type": "query", "description": "Start time in UTC (YYYY-MM-DDThh:mm:ss)" }, { "name": "endTimeUtc", "value": "", "type": "query", "description": "End time in UTC (YYYY-MM-DDThh:mm:ss)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Works only on Enterprise Nodes.\r\n \r\nThe maximum time range allowed is 7 days over the period of last 365 days. If no time range is provided, last 24-hour data is returned." }, { "info": { "name": "Returns the number of tests based on Node ID.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/nodes/testruncount/:nodeId", "params": [ { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "startTimeUtc", "value": "", "type": "query", "description": "Start time in UTC (YYYY-MM-DDThh:mm:ss)" }, { "name": "endTimeUtc", "value": "", "type": "query", "description": "End time in UTC (YYYY-MM-DDThh:mm:ss)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Works only on Enterprise Nodes.\r\n \r\nThe maximum time range allowed is 7 days over the period of last 365 days. If no time range is provided, last 24-hour data is returned." }, { "info": { "name": "Returns the average test time taken based on Node ID.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/nodes/testtime/:nodeId", "params": [ { "name": "nodeId", "value": "", "type": "path", "description": "Node ID" }, { "name": "startTimeUtc", "value": "", "type": "query", "description": "Start time in UTC (YYYY-MM-DDThh:mm:ss)" }, { "name": "endTimeUtc", "value": "", "type": "query", "description": "End time in UTC (YYYY-MM-DDThh:mm:ss)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Works only on Enterprise Nodes.\r\n \r\nThe maximum time range allowed is 7 days over the period of last 365 days. If no time range is provided, last 24-hour data is returned." } ] } ], "bundled": true }