Get a service's endpoints

GET

/api-catalog/services/:serviceId/endpoints

GET

/api-catalog/services/:serviceId/endpoints

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

1 {
2   "meta": {
3     "nextCursor": null,
4     "limit": 20,
5     "filters": {
6       "systemEnvironmentId": "23b554c1-c30c-483d-bf98-dbe9ab7b88a0"
7     },
8     "timeRange": {
9       "start": "2026-04-14T13:10:07.480Z",
10       "end": "2026-04-21T13:10:07.480Z",
11       "label": "last_7_days"
12     },
13     "totalEndpoints": 11,
14     "totalRequests": 16022
15   },
16   "data": [
17     {
18       "method": "PATCH",
19       "path": "/api/v1/object-groups/{group}",
20       "host": "acs-test-new.example.com",
21       "requestCount": 2916,
22       "performance": {
23         "p90LatencyMs": 19.701,
24         "p95LatencyMs": 21.59825
25       },
26       "errors": {
27         "totalErrors": 16,
28         "errorRatePct": 0.55,
29         "breakdown": {
30           "400": 8,
31           "500": 8
32         }
33       }
34     },
35     {
36       "method": "DELETE",
37       "path": "/api/v1/object-groups/{group}",
38       "host": "acs-test-new.example.com",
39       "requestCount": 2866,
40       "performance": {
41         "p90LatencyMs": 30.4165,
42         "p95LatencyMs": 33.5495
43       },
44       "errors": {
45         "totalErrors": 6,
46         "errorRatePct": 0.21,
47         "breakdown": {
48           "400": 6
49         }
50       }
51     },
52     {
53       "method": "POST",
54       "path": "/api/v1/object-groups",
55       "host": "acs-test-new.example.com",
56       "requestCount": 2774,
57       "performance": {
58         "p90LatencyMs": 20.300701,
59         "p95LatencyMs": 22.9377
60       },
61       "errors": {
62         "totalErrors": 20,
63         "errorRatePct": 0.72,
64         "breakdown": {
65           "401": 12,
66           "500": 8
67         }
68       }
69     },
70     {
71       "method": "POST",
72       "path": "/api/permissions/check",
73       "host": "acs-test-new.example.com",
74       "requestCount": 2063,
75       "performance": {
76         "p90LatencyMs": 295.8238,
77         "p95LatencyMs": 321.0344
78       },
79       "errors": {
80         "totalErrors": 8,
81         "errorRatePct": 0.39,
82         "breakdown": {
83           "400": 6,
84           "500": 2
85         }
86       }
87     },
88     {
89       "method": "POST",
90       "path": "/api/v2/groups",
91       "host": "acs-test-new.example.com",
92       "requestCount": 1979,
93       "performance": {
94         "p90LatencyMs": 21.105799,
95         "p95LatencyMs": 23.576601
96       },
97       "errors": {
98         "totalErrors": 2,
99         "errorRatePct": 0.1,
100         "breakdown": {
101           "401": 2
102         }
103       }
104     },
105     {
106       "method": "POST",
107       "path": "/api/groups/delete",
108       "host": "acs-test-new.example.com",
109       "requestCount": 1033,
110       "performance": {
111         "p90LatencyMs": 43.736202,
112         "p95LatencyMs": 48.807
113       },
114       "errors": {
115         "totalErrors": 2,
116         "errorRatePct": 0.19,
117         "breakdown": {
118           "401": 2
119         }
120       }
121     },
122     {
123       "method": "POST",
124       "path": "/api/roles/add",
125       "host": "acs-test-new.example.com",
126       "requestCount": 1031,
127       "performance": {
128         "p90LatencyMs": 20.06,
129         "p95LatencyMs": 22.2735
130       },
131       "errors": {
132         "totalErrors": 4,
133         "errorRatePct": 0.39,
134         "breakdown": {
135           "401": 4
136         }
137       }
138     },
139     {
140       "method": "POST",
141       "path": "/api/permissions/list/by-objects",
142       "host": "acs-test-new.example.com",
143       "requestCount": 928,
144       "performance": {
145         "p90LatencyMs": 193.14041,
146         "p95LatencyMs": 219.2336
147       },
148       "errors": {
149         "totalErrors": 2,
150         "errorRatePct": 0.22,
151         "breakdown": {
152           "401": 2
153         }
154       }
155     },
156     {
157       "method": "GET",
158       "path": "/api/v1/role-assignments",
159       "host": "acs-test-new.example.com",
160       "requestCount": 382,
161       "performance": {
162         "p90LatencyMs": 12.8354,
163         "p95LatencyMs": 15.002851
164       },
165       "errors": {
166         "totalErrors": 96,
167         "errorRatePct": 25.13,
168         "breakdown": {
169           "400": 96
170         }
171       }
172     },
173     {
174       "method": "POST",
175       "path": "/api/roles/remove",
176       "host": "acs-test-new.example.com",
177       "requestCount": 48,
178       "performance": {
179         "p90LatencyMs": 32.1342,
180         "p95LatencyMs": 34.145298
181       },
182       "errors": {
183         "totalErrors": 0,
184         "errorRatePct": 0,
185         "breakdown": {}
186       }
187     },
188     {
189       "method": "GET",
190       "path": "/api/permissions/MANAGE_SYSTEM_ENVIRONMENT",
191       "host": "acs-test-new.example.com",
192       "requestCount": 2,
193       "performance": {
194         "p90LatencyMs": 11.3602,
195         "p95LatencyMs": 11.3716
196       },
197       "errors": {
198         "totalErrors": 0,
199         "errorRatePct": 0,
200         "breakdown": {}
201       }
202     }
203   ]
204 }

Get a list of observed API endpoints for a service and its performance metrics.

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.

A.comma-separated list of HTTP methods to filter the results by.

hostsstringOptionalformat: "^[^,]+(,[^,]+)*$"

A comma-separated list of hostnames to filter the results by.

responseCodesstringOptionalformat: "^\\d{3}(,\\d{3})*$"

A comma-separated list of HTTP status codes to filter the results by.

searchstringOptional<=500 characters

Filter results to the search filter given on the endpoint's path.

sortstringOptionalformat: "^(count|endpoint|p95LatencyMs|errorRate):(asc|desc)$"

Sort the results in field:direction order format. Accepts the count, endpoint, p95LatencyMs, and errorRate fields. Supports the asc and desc directions.

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 observed API endpoints with traffic and performance metrics.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error