Get a service's monitor runs

GET

/api-catalog/services/:serviceId/monitor-runs

GET

/api-catalog/services/:serviceId/monitor-runs

$ curl -G https://api.getpostman.com/api-catalog/services/c6ec74e7-14f8-498c-9470-7a654173bed6/monitor-runs \
>      -H "x-api-key: <apiKey>" \
>      -d systemEnvironmentId=23b554c1-c30c-483d-bf98-dbe9ab7b88a0

1 {
2   "meta": {
3     "nextCursor": null,
4     "limit": 5,
5     "filters": {
6       "systemEnvironmentId": "23b554c1-c30c-483d-bf98-dbe9ab7b88a0"
7     },
8     "timeRange": {
9       "start": "2026-04-14T13:19:51.736Z",
10       "end": "2026-04-21T13:19:51.736Z",
11       "label": "last_7_days"
12     },
13     "totalRuns": 1034,
14     "passedRuns": 456,
15     "failedRuns": 578,
16     "successRatePct": 44.1
17   },
18   "data": [
19     {
20       "id": "019d9ef1-4441-7d5d-892b-cf280e19c12d",
21       "status": "passed",
22       "timestamp": "2026-04-18T04:55:04.898Z",
23       "collection": {
24         "id": "12345678-528df970-ceec-45a5-9f72-187ea19ff53b",
25         "name": "[PROD] API Control Service"
26       },
27       "environment": {
28         "id": "12345678-9b83df88-9b5c-445b-ac23-460c37897340",
29         "name": "[PROD] API Control Service"
30       },
31       "summary": {
32         "totalRequests": 16,
33         "failedRequests": 0,
34         "totalAssertions": 56,
35         "failedAssertions": 0,
36         "durationMs": 1747
37       },
38       "performance": {
39         "minResponseMs": 17,
40         "maxResponseMs": 308
41       }
42     },
43     {
44       "id": "019d9eec-b572-7ea0-a76f-be24a3fa9e65",
45       "status": "failed",
46       "timestamp": "2026-04-18T04:50:06.226Z",
47       "collection": {
48         "id": "12345678-528df970-ceec-45a5-9f72-187ea19ff53b",
49         "name": "[PROD] API Control Service"
50       },
51       "environment": {
52         "id": "12345678-9b83df88-9b5c-445b-ac23-460c37897340",
53         "name": "[PROD] API Control Service"
54       },
55       "summary": {
56         "totalRequests": 16,
57         "failedRequests": 0,
58         "totalAssertions": 56,
59         "failedAssertions": 1,
60         "durationMs": 1666
61       },
62       "performance": {
63         "minResponseMs": 20,
64         "maxResponseMs": 279
65       }
66     },
67     {
68       "id": "019d9ee8-2d69-70ce-aee3-4d45a01dda3b",
69       "status": "failed",
70       "timestamp": "2026-04-18T04:45:09.245Z",
71       "collection": {
72         "id": "12345678-528df970-ceec-45a5-9f72-187ea19ff53b",
73         "name": "[PROD] API Control Service"
74       },
75       "environment": {
76         "id": "12345678-9b83df88-9b5c-445b-ac23-460c37897340",
77         "name": "[PROD] API Control Service"
78       },
79       "summary": {
80         "totalRequests": 16,
81         "failedRequests": 0,
82         "totalAssertions": 56,
83         "failedAssertions": 1,
84         "durationMs": 1506
85       },
86       "performance": {
87         "minResponseMs": 16,
88         "maxResponseMs": 250
89       }
90     },
91     {
92       "id": "019d9ee3-a669-7e8c-8bb3-f10e7e557081",
93       "status": "failed",
94       "timestamp": "2026-04-18T04:40:12.552Z",
95       "collection": {
96         "id": "12345678-528df970-ceec-45a5-9f72-187ea19ff53b",
97         "name": "[PROD] API Control Service"
98       },
99       "environment": {
100         "id": "12345678-9b83df88-9b5c-445b-ac23-460c37897340",
101         "name": "[PROD] API Control Service"
102       },
103       "summary": {
104         "totalRequests": 16,
105         "failedRequests": 0,
106         "totalAssertions": 56,
107         "failedAssertions": 1,
108         "durationMs": 1815
109       },
110       "performance": {
111         "minResponseMs": 16,
112         "maxResponseMs": 355
113       }
114     },
115     {
116       "id": "019d9edf-039c-73d5-ab3d-38c4dbacb5c9",
117       "status": "passed",
118       "timestamp": "2026-04-18T04:35:08.737Z",
119       "collection": {
120         "id": "12345678-528df970-ceec-45a5-9f72-187ea19ff53b",
121         "name": "[PROD] API Control Service"
122       },
123       "environment": {
124         "id": "12345678-9b83df88-9b5c-445b-ac23-460c37897340",
125         "name": "[PROD] API Control Service"
126       },
127       "summary": {
128         "totalRequests": 16,
129         "failedRequests": 0,
130         "totalAssertions": 56,
131         "failedAssertions": 0,
132         "durationMs": 1607
133       },
134       "performance": {
135         "minResponseMs": 18,
136         "maxResponseMs": 325
137       }
138     }
139   ]
140 }

Gets a list of scheduled monitor runs for a service that includes summary statistics.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

serviceIdstringRequired

The service's ID.

Query parameters

systemEnvironmentIdstringRequired

The system environment's ID.

collectionIdstringOptionalformat: "uid"

Filter results to only the given collection ID's runs.

sortstringOptionalformat: "^(timestamp|duration|failedAssertions):(asc|desc)$"

Sort the results in field:direction order format. Accepts the timestamp, duration, and failedAssertions fields. Supports the asc and desc directions.

environmentIdstringOptional

Filter results to only the given environment ID runs.

statusenumOptional

Filter results by run status.

Allowed values:

limitintegerOptional1-100Defaults to 20

The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than 100 returns a 400 Bad Request response.

cursorstringOptional

The pointer to the first record of the set of paginated results. To view the next response, use the nextCursor value for this parameter.

Response

Successful Response

metaobject

The response's meta information for paginated results.

datalist of objects

A list of monitor runs.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error