Run a Monitor
POST
/monitors/{monitor_uid}/run
Monitors
Requires API Key as X-Api-Key
request header orapikey
URL query parameter.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.getpostman.com/monitors//run'
Response Response Example
{
"run": {
"executions": [
{
"id": 1,
"item": {
"id": "b5e8d7dd-909c-4ba7-aef4-8609bc50b586",
"name": "Sample POST Request"
},
"request": {
"body": {
"contentLength": 18,
"mode": "raw"
},
"headers": {
"accept": "*/*",
"accept-encoding": "gzip, deflate",
"content-length": 18,
"content-type": "application/json"
},
"method": "POST",
"timestamp": "2016-12-04T14:30:26.025Z",
"url": "echo.getpostman.com/post"
},
"response": {
"body": {
"contentLength": 298
},
"code": 200,
"headers": {
"connection": "keep-alive",
"content-encoding": "gzip",
"content-type": "application/json",
"date": "Sun, 04 Dec 2016 14:30:26 GMT",
"transfer-encoding": "chunked"
},
"responseSize": 298,
"responseTime": 26
}
},
{
"assertions": {
"Status code is 400": false
},
"id": 2,
"item": {
"id": "f790d046-755d-44f5-a416-b825e18dfd9d",
"name": "Sample GET Request"
},
"request": {
"body": {
"contentLength": 0,
"mode": "formdata"
},
"headers": {
"accept": "*/*",
"accept-encoding": "gzip, deflate"
},
"method": "GET",
"timestamp": "2016-12-04T14:30:26.093Z",
"url": "echo.getpostman.com/get"
},
"response": {
"body": {
"contentLength": 280
},
"code": 200,
"headers": {
"connection": "keep-alive",
"content-encoding": "gzip",
"content-type": "application/json",
"date": "Sun, 04 Dec 2016 14:30:26 GMT",
"transfer-encoding": "chunked"
},
"responseSize": 280,
"responseTime": 46
}
},
{
"id": 3,
"item": {
"id": "336e6e17-6d3e-4b8f-a48f-b7e75cf13afb",
"name": "This is the second request"
},
"request": {
"body": {
"contentLength": 0,
"mode": "formdata"
},
"headers": {
"accept": "*/*",
"accept-encoding": "gzip, deflate",
"content-length": 18
},
"method": "POST",
"timestamp": "2016-12-04T14:30:26.477Z",
"url": "echo.getpostman.com/post"
},
"response": {
"body": {
"contentLength": 345
},
"code": 200,
"headers": {
"connection": "keep-alive",
"content-encoding": "gzip",
"content-type": "application/json",
"date": "Sun, 04 Dec 2016 14:30:26 GMT",
"transfer-encoding": "chunked"
},
"responseSize": 345,
"responseTime": 9
}
}
],
"failures": [
{
"assertion": {
"Status code is 400": false
},
"executionId": 2,
"message": "Expected 'Status code is 400' to be truthy",
"name": "AssertionError"
}
],
"info": {
"collectionUid": "5852-1d3daef4-2037-4584-ab86-bafd8c8f8a55",
"finishedAt": "2016-12-04T14:30:26.000Z",
"jobId": "1e6ba2e3-1aaf-4c10-bd5f-905943284b2a",
"monitorId": "1e6b8970-fd13-4480-b011-b3b3e3cd271d",
"name": "Sample Collection monitor 1 #56",
"startedAt": "2016-12-04T14:30:25.000Z",
"status": "failed"
},
"stats": {
"assertions": {
"failed": 1,
"total": 1
},
"requests": {
"failed": 1,
"total": 3
}
}
}
}
Request
Path Params
monitor_uid
stringÂ
required
Responses
Modified at 2023-08-15 05:41:04