Logo
30 Day Challange API Documentation

Run a monitor

POST https://api.getpostman.com/monitors/{{monitorId}}/run

Runs a monitor and returns its run results.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "run": { "info": { "jobId": "1ecee76a-e14e-47c0-bddc-256bf690c407", "monitorId": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1", "name": "Test Monitor", "collectionUid": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2", "environmentUid": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e", "status": "error", "startedAt": "2022-06-17T20:04:47.183Z", "finishedAt": "2022-06-17T20:04:48.858Z" }, "stats": { "assertions": { "total": 4, "failed": 2 }, "requests": { "total": 4, "failed": 3 } }, "executions": [ { "id": 1, "item": { "name": "Sample GET Request" }, "request": { "method": "GET", "url": "https://example.com/search?format=json&state=&city=&country=", "headers": { "User-Agent": "PostmanRuntime/7.29.0", "Accept": "*/*", "Cache-Control": "no-cache", "Postman-Token": null, "Host": "example.com", "Accept-Encoding": "gzip, deflate, br", "Connection": "keep-alive" }, "body": { "contentLength": 0 }, "timestamp": "2022-06-17T20:04:47.926Z" }, "response": { "code": 200, "body": { "contentLength": 2 }, "responseTime": 257, "responseSize": 2, "headers": { "Server": null, "Date": "Fri, 17 Jun 2022 20:04:47 GMT", "Content-Type": "application/json; charset=UTF-8", "Transfer-Encoding": "chunked", "Connection": "keep-alive", "Keep-Alive": null, "Access-Control-Allow-Origin": "*", "Access-Control-Allow-Methods": "OPTIONS,GET" } }, "errors": [ { "name": "TypeError", "message": "Cannot read property 'lat' of undefined" } ] } ], "failures": [ { "executionId": 1, "name": "TypeError", "message": "Cannot read property 'lat' of undefined" } ] } }



Curl
curl -X POST 'https://api.getpostman.com/monitors/undefined/run'

ENDPOINTS