Get a monitor

GET

/monitors/:monitorId

GET

/monitors/:monitorId

$ curl https://api.postman.com/monitors/1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 \
>      -H "x-api-key: <apiKey>"

1 {
2   "monitor": {
3     "id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
4     "name": "Test Monitor",
5     "uid": "12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
6     "owner": 12345678,
7     "active": true,
8     "notificationLimit": 1,
9     "collectionUid": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
10     "environmentUid": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e",
11     "jobId": "e72dc3de-e4ac-407c-b1cc-2c5b6efced68",
12     "options": {
13       "followRedirects": true,
14       "requestDelay": 1,
15       "requestTimeout": 3000,
16       "strictSSL": true
17     },
18     "notifications": {
19       "onError": [
20         {
21           "email": "taylor.lee@example.com"
22         }
23       ],
24       "onFailure": [
25         {
26           "email": "taylor.lee@example.com"
27         }
28       ]
29     },
30     "distribution": [
31       {
32         "region": "us-east"
33       }
34     ],
35     "schedule": {
36       "cron": "0 0 * * * *",
37       "nextRun": "2025-06-18T05:00:00.000Z",
38       "timezone": "America/Chicago"
39     },
40     "retry": {
41       "attempts": 1
42     },
43     "lastRun": {
44       "status": "success",
45       "startedAt": "2025-06-17T18:39:52.852Z",
46       "finishedAt": "2025-06-17T18:39:53.707Z",
47       "stats": {
48         "assertions": {
49           "total": 5,
50           "failed": 0
51         },
52         "requests": {
53           "total": 3
54         },
55         "runCount": 42,
56         "errorCount": 0,
57         "abortedCount": 2,
58         "responseLatency": 850,
59         "responseSize": 2048
60       },
61       "jobId": "e72dc3de-e4ac-407c-b1cc-2c5b6efced68"
62     }
63   }
64 }

Gets information about a monitor.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

monitorIdstringRequired

The monitor's ID.

Response

Successful Response

monitorobject

Information about the monitor.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error