@salesforce/b2c-tooling-sdk 1.18.0 → 1.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/clients/index.d.ts +2 -0
- package/dist/esm/clients/index.js +1 -0
- package/dist/esm/clients/index.js.map +1 -1
- package/dist/esm/clients/metrics.d.ts +123 -0
- package/dist/esm/clients/metrics.generated.d.ts +1016 -0
- package/dist/esm/clients/metrics.generated.js +6 -0
- package/dist/esm/clients/metrics.generated.js.map +1 -0
- package/dist/esm/clients/metrics.js +65 -0
- package/dist/esm/clients/metrics.js.map +1 -0
- package/dist/esm/clients/middleware-registry.d.ts +1 -1
- package/dist/esm/clients/middleware-registry.js.map +1 -1
- package/dist/esm/index.d.ts +4 -2
- package/dist/esm/index.js +3 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/operations/logs/filter.d.ts +6 -1
- package/dist/esm/operations/logs/filter.js +7 -2
- package/dist/esm/operations/logs/filter.js.map +1 -1
- package/dist/esm/operations/metrics/index.d.ts +371 -0
- package/dist/esm/operations/metrics/index.js +478 -0
- package/dist/esm/operations/metrics/index.js.map +1 -0
- package/dist/esm/operations/metrics/tags.d.ts +148 -0
- package/dist/esm/operations/metrics/tags.js +235 -0
- package/dist/esm/operations/metrics/tags.js.map +1 -0
- package/package.json +6 -2
- package/specs/metrics-v1.json +1713 -0
|
@@ -0,0 +1,1713 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.3",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Metrics",
|
|
5
|
+
"version": "1.0.0",
|
|
6
|
+
"x-api-type": "Admin",
|
|
7
|
+
"x-api-family": "Observability"
|
|
8
|
+
},
|
|
9
|
+
"servers": [
|
|
10
|
+
{
|
|
11
|
+
"url": "https://{shortCode}.api.commercecloud.salesforce.com/observability/metrics/v1",
|
|
12
|
+
"variables": {
|
|
13
|
+
"shortCode": {
|
|
14
|
+
"default": "shortCode"
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"paths": {
|
|
20
|
+
"/organizations/{organizationId}/metrics/overall": {
|
|
21
|
+
"get": {
|
|
22
|
+
"operationId": "getOverallMetrics",
|
|
23
|
+
"parameters": [
|
|
24
|
+
{
|
|
25
|
+
"name": "organizationId",
|
|
26
|
+
"in": "path",
|
|
27
|
+
"required": true,
|
|
28
|
+
"style": "simple",
|
|
29
|
+
"explode": false,
|
|
30
|
+
"schema": {
|
|
31
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "from",
|
|
36
|
+
"in": "query",
|
|
37
|
+
"required": false,
|
|
38
|
+
"style": "form",
|
|
39
|
+
"explode": true,
|
|
40
|
+
"schema": {
|
|
41
|
+
"type": "integer",
|
|
42
|
+
"format": "int64",
|
|
43
|
+
"minimum": 1
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "to",
|
|
48
|
+
"in": "query",
|
|
49
|
+
"required": false,
|
|
50
|
+
"style": "form",
|
|
51
|
+
"explode": true,
|
|
52
|
+
"schema": {
|
|
53
|
+
"type": "integer",
|
|
54
|
+
"format": "int64",
|
|
55
|
+
"minimum": 1
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
],
|
|
59
|
+
"responses": {
|
|
60
|
+
"200": {
|
|
61
|
+
"description": "Successfully retrieved overall application metrics for the requested time window",
|
|
62
|
+
"content": {
|
|
63
|
+
"application/json": {
|
|
64
|
+
"schema": {
|
|
65
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"400": {
|
|
71
|
+
"description": "Bad request — invalid time parameters",
|
|
72
|
+
"content": {
|
|
73
|
+
"application/problem+json": {
|
|
74
|
+
"schema": {
|
|
75
|
+
"oneOf": [
|
|
76
|
+
{
|
|
77
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
81
|
+
}
|
|
82
|
+
]
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
"401": {
|
|
88
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
89
|
+
"content": {
|
|
90
|
+
"application/problem+json": {
|
|
91
|
+
"schema": {
|
|
92
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"403": {
|
|
98
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
99
|
+
"content": {
|
|
100
|
+
"application/problem+json": {
|
|
101
|
+
"schema": {
|
|
102
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
"404": {
|
|
108
|
+
"description": "Metrics category not available for the organization",
|
|
109
|
+
"content": {
|
|
110
|
+
"application/problem+json": {
|
|
111
|
+
"schema": {
|
|
112
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
},
|
|
117
|
+
"503": {
|
|
118
|
+
"description": "Metrics data temporarily unavailable",
|
|
119
|
+
"content": {
|
|
120
|
+
"application/problem+json": {
|
|
121
|
+
"schema": {
|
|
122
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
"security": [
|
|
129
|
+
{
|
|
130
|
+
"AmOAuth2": [
|
|
131
|
+
"sfcc.metrics"
|
|
132
|
+
]
|
|
133
|
+
}
|
|
134
|
+
]
|
|
135
|
+
}
|
|
136
|
+
},
|
|
137
|
+
"/organizations/{organizationId}/metrics/sales": {
|
|
138
|
+
"get": {
|
|
139
|
+
"operationId": "getSalesMetrics",
|
|
140
|
+
"parameters": [
|
|
141
|
+
{
|
|
142
|
+
"name": "organizationId",
|
|
143
|
+
"in": "path",
|
|
144
|
+
"required": true,
|
|
145
|
+
"style": "simple",
|
|
146
|
+
"explode": false,
|
|
147
|
+
"schema": {
|
|
148
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
149
|
+
}
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
"name": "from",
|
|
153
|
+
"in": "query",
|
|
154
|
+
"required": false,
|
|
155
|
+
"style": "form",
|
|
156
|
+
"explode": true,
|
|
157
|
+
"schema": {
|
|
158
|
+
"type": "integer",
|
|
159
|
+
"format": "int64",
|
|
160
|
+
"minimum": 1
|
|
161
|
+
}
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"name": "to",
|
|
165
|
+
"in": "query",
|
|
166
|
+
"required": false,
|
|
167
|
+
"style": "form",
|
|
168
|
+
"explode": true,
|
|
169
|
+
"schema": {
|
|
170
|
+
"type": "integer",
|
|
171
|
+
"format": "int64",
|
|
172
|
+
"minimum": 1
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
],
|
|
176
|
+
"responses": {
|
|
177
|
+
"200": {
|
|
178
|
+
"description": "Successfully retrieved sales metrics for the requested time window",
|
|
179
|
+
"content": {
|
|
180
|
+
"application/json": {
|
|
181
|
+
"schema": {
|
|
182
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
"400": {
|
|
188
|
+
"description": "Bad request — invalid time parameters",
|
|
189
|
+
"content": {
|
|
190
|
+
"application/problem+json": {
|
|
191
|
+
"schema": {
|
|
192
|
+
"oneOf": [
|
|
193
|
+
{
|
|
194
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
198
|
+
}
|
|
199
|
+
]
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
},
|
|
204
|
+
"401": {
|
|
205
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
206
|
+
"content": {
|
|
207
|
+
"application/problem+json": {
|
|
208
|
+
"schema": {
|
|
209
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
},
|
|
214
|
+
"403": {
|
|
215
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
216
|
+
"content": {
|
|
217
|
+
"application/problem+json": {
|
|
218
|
+
"schema": {
|
|
219
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
},
|
|
224
|
+
"404": {
|
|
225
|
+
"description": "Metrics category not available for the organization",
|
|
226
|
+
"content": {
|
|
227
|
+
"application/problem+json": {
|
|
228
|
+
"schema": {
|
|
229
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
"503": {
|
|
235
|
+
"description": "Metrics data temporarily unavailable",
|
|
236
|
+
"content": {
|
|
237
|
+
"application/problem+json": {
|
|
238
|
+
"schema": {
|
|
239
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
},
|
|
245
|
+
"security": [
|
|
246
|
+
{
|
|
247
|
+
"AmOAuth2": [
|
|
248
|
+
"sfcc.metrics"
|
|
249
|
+
]
|
|
250
|
+
}
|
|
251
|
+
]
|
|
252
|
+
}
|
|
253
|
+
},
|
|
254
|
+
"/organizations/{organizationId}/metrics/ecdn": {
|
|
255
|
+
"get": {
|
|
256
|
+
"operationId": "getEcdnMetrics",
|
|
257
|
+
"parameters": [
|
|
258
|
+
{
|
|
259
|
+
"name": "organizationId",
|
|
260
|
+
"in": "path",
|
|
261
|
+
"required": true,
|
|
262
|
+
"style": "simple",
|
|
263
|
+
"explode": false,
|
|
264
|
+
"schema": {
|
|
265
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
266
|
+
}
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "from",
|
|
270
|
+
"in": "query",
|
|
271
|
+
"required": false,
|
|
272
|
+
"style": "form",
|
|
273
|
+
"explode": true,
|
|
274
|
+
"schema": {
|
|
275
|
+
"type": "integer",
|
|
276
|
+
"format": "int64",
|
|
277
|
+
"minimum": 1
|
|
278
|
+
}
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"name": "to",
|
|
282
|
+
"in": "query",
|
|
283
|
+
"required": false,
|
|
284
|
+
"style": "form",
|
|
285
|
+
"explode": true,
|
|
286
|
+
"schema": {
|
|
287
|
+
"type": "integer",
|
|
288
|
+
"format": "int64",
|
|
289
|
+
"minimum": 1
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
],
|
|
293
|
+
"responses": {
|
|
294
|
+
"200": {
|
|
295
|
+
"description": "Successfully retrieved eCDN metrics for the requested time window",
|
|
296
|
+
"content": {
|
|
297
|
+
"application/json": {
|
|
298
|
+
"schema": {
|
|
299
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
},
|
|
304
|
+
"400": {
|
|
305
|
+
"description": "Bad request — invalid time parameters",
|
|
306
|
+
"content": {
|
|
307
|
+
"application/problem+json": {
|
|
308
|
+
"schema": {
|
|
309
|
+
"oneOf": [
|
|
310
|
+
{
|
|
311
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
315
|
+
}
|
|
316
|
+
]
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
},
|
|
321
|
+
"401": {
|
|
322
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
323
|
+
"content": {
|
|
324
|
+
"application/problem+json": {
|
|
325
|
+
"schema": {
|
|
326
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
327
|
+
}
|
|
328
|
+
}
|
|
329
|
+
}
|
|
330
|
+
},
|
|
331
|
+
"403": {
|
|
332
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
333
|
+
"content": {
|
|
334
|
+
"application/problem+json": {
|
|
335
|
+
"schema": {
|
|
336
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
},
|
|
341
|
+
"404": {
|
|
342
|
+
"description": "Metrics category not available for the organization",
|
|
343
|
+
"content": {
|
|
344
|
+
"application/problem+json": {
|
|
345
|
+
"schema": {
|
|
346
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
347
|
+
}
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
"503": {
|
|
352
|
+
"description": "Metrics data temporarily unavailable",
|
|
353
|
+
"content": {
|
|
354
|
+
"application/problem+json": {
|
|
355
|
+
"schema": {
|
|
356
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
357
|
+
}
|
|
358
|
+
}
|
|
359
|
+
}
|
|
360
|
+
}
|
|
361
|
+
},
|
|
362
|
+
"security": [
|
|
363
|
+
{
|
|
364
|
+
"AmOAuth2": [
|
|
365
|
+
"sfcc.metrics"
|
|
366
|
+
]
|
|
367
|
+
}
|
|
368
|
+
]
|
|
369
|
+
}
|
|
370
|
+
},
|
|
371
|
+
"/organizations/{organizationId}/metrics/third-party": {
|
|
372
|
+
"get": {
|
|
373
|
+
"operationId": "getThirdPartyMetrics",
|
|
374
|
+
"parameters": [
|
|
375
|
+
{
|
|
376
|
+
"name": "organizationId",
|
|
377
|
+
"in": "path",
|
|
378
|
+
"required": true,
|
|
379
|
+
"style": "simple",
|
|
380
|
+
"explode": false,
|
|
381
|
+
"schema": {
|
|
382
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
383
|
+
}
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"name": "from",
|
|
387
|
+
"in": "query",
|
|
388
|
+
"required": false,
|
|
389
|
+
"style": "form",
|
|
390
|
+
"explode": true,
|
|
391
|
+
"schema": {
|
|
392
|
+
"type": "integer",
|
|
393
|
+
"format": "int64",
|
|
394
|
+
"minimum": 1
|
|
395
|
+
}
|
|
396
|
+
},
|
|
397
|
+
{
|
|
398
|
+
"name": "to",
|
|
399
|
+
"in": "query",
|
|
400
|
+
"required": false,
|
|
401
|
+
"style": "form",
|
|
402
|
+
"explode": true,
|
|
403
|
+
"schema": {
|
|
404
|
+
"type": "integer",
|
|
405
|
+
"format": "int64",
|
|
406
|
+
"minimum": 1
|
|
407
|
+
}
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"name": "thirdPartyServiceId",
|
|
411
|
+
"in": "query",
|
|
412
|
+
"required": false,
|
|
413
|
+
"style": "form",
|
|
414
|
+
"explode": true,
|
|
415
|
+
"schema": {
|
|
416
|
+
"$ref": "#/components/schemas/ThirdPartyServiceId"
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
],
|
|
420
|
+
"responses": {
|
|
421
|
+
"200": {
|
|
422
|
+
"description": "Successfully retrieved third party service metrics for the requested time window",
|
|
423
|
+
"content": {
|
|
424
|
+
"application/json": {
|
|
425
|
+
"schema": {
|
|
426
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
}
|
|
430
|
+
},
|
|
431
|
+
"400": {
|
|
432
|
+
"description": "Bad request — invalid time parameters or third party service filter",
|
|
433
|
+
"content": {
|
|
434
|
+
"application/problem+json": {
|
|
435
|
+
"schema": {
|
|
436
|
+
"oneOf": [
|
|
437
|
+
{
|
|
438
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
"$ref": "#/components/schemas/InvalidThirdPartyServiceErrorResponse"
|
|
445
|
+
}
|
|
446
|
+
]
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
}
|
|
450
|
+
},
|
|
451
|
+
"401": {
|
|
452
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
453
|
+
"content": {
|
|
454
|
+
"application/problem+json": {
|
|
455
|
+
"schema": {
|
|
456
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
457
|
+
}
|
|
458
|
+
}
|
|
459
|
+
}
|
|
460
|
+
},
|
|
461
|
+
"403": {
|
|
462
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
463
|
+
"content": {
|
|
464
|
+
"application/problem+json": {
|
|
465
|
+
"schema": {
|
|
466
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
467
|
+
}
|
|
468
|
+
}
|
|
469
|
+
}
|
|
470
|
+
},
|
|
471
|
+
"404": {
|
|
472
|
+
"description": "Metrics category not available for the organization",
|
|
473
|
+
"content": {
|
|
474
|
+
"application/problem+json": {
|
|
475
|
+
"schema": {
|
|
476
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
477
|
+
}
|
|
478
|
+
}
|
|
479
|
+
}
|
|
480
|
+
},
|
|
481
|
+
"503": {
|
|
482
|
+
"description": "Metrics data temporarily unavailable",
|
|
483
|
+
"content": {
|
|
484
|
+
"application/problem+json": {
|
|
485
|
+
"schema": {
|
|
486
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
487
|
+
}
|
|
488
|
+
}
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
},
|
|
492
|
+
"security": [
|
|
493
|
+
{
|
|
494
|
+
"AmOAuth2": [
|
|
495
|
+
"sfcc.metrics"
|
|
496
|
+
]
|
|
497
|
+
}
|
|
498
|
+
]
|
|
499
|
+
}
|
|
500
|
+
},
|
|
501
|
+
"/organizations/{organizationId}/metrics/scapi": {
|
|
502
|
+
"get": {
|
|
503
|
+
"operationId": "getScapiMetrics",
|
|
504
|
+
"parameters": [
|
|
505
|
+
{
|
|
506
|
+
"name": "organizationId",
|
|
507
|
+
"in": "path",
|
|
508
|
+
"required": true,
|
|
509
|
+
"style": "simple",
|
|
510
|
+
"explode": false,
|
|
511
|
+
"schema": {
|
|
512
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
513
|
+
}
|
|
514
|
+
},
|
|
515
|
+
{
|
|
516
|
+
"name": "from",
|
|
517
|
+
"in": "query",
|
|
518
|
+
"required": false,
|
|
519
|
+
"style": "form",
|
|
520
|
+
"explode": true,
|
|
521
|
+
"schema": {
|
|
522
|
+
"type": "integer",
|
|
523
|
+
"format": "int64",
|
|
524
|
+
"minimum": 1
|
|
525
|
+
}
|
|
526
|
+
},
|
|
527
|
+
{
|
|
528
|
+
"name": "to",
|
|
529
|
+
"in": "query",
|
|
530
|
+
"required": false,
|
|
531
|
+
"style": "form",
|
|
532
|
+
"explode": true,
|
|
533
|
+
"schema": {
|
|
534
|
+
"type": "integer",
|
|
535
|
+
"format": "int64",
|
|
536
|
+
"minimum": 1
|
|
537
|
+
}
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
"name": "apiFamily",
|
|
541
|
+
"in": "query",
|
|
542
|
+
"required": false,
|
|
543
|
+
"style": "form",
|
|
544
|
+
"explode": true,
|
|
545
|
+
"schema": {
|
|
546
|
+
"type": "string",
|
|
547
|
+
"maxLength": 100,
|
|
548
|
+
"minLength": 1
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"name": "apiName",
|
|
553
|
+
"in": "query",
|
|
554
|
+
"required": false,
|
|
555
|
+
"style": "form",
|
|
556
|
+
"explode": true,
|
|
557
|
+
"schema": {
|
|
558
|
+
"type": "string",
|
|
559
|
+
"maxLength": 100,
|
|
560
|
+
"minLength": 1
|
|
561
|
+
}
|
|
562
|
+
}
|
|
563
|
+
],
|
|
564
|
+
"responses": {
|
|
565
|
+
"200": {
|
|
566
|
+
"description": "Successfully retrieved SCAPI metrics for the requested time window",
|
|
567
|
+
"content": {
|
|
568
|
+
"application/json": {
|
|
569
|
+
"schema": {
|
|
570
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
571
|
+
}
|
|
572
|
+
}
|
|
573
|
+
}
|
|
574
|
+
},
|
|
575
|
+
"400": {
|
|
576
|
+
"description": "Bad request — invalid time parameters or SCAPI filter value",
|
|
577
|
+
"content": {
|
|
578
|
+
"application/problem+json": {
|
|
579
|
+
"schema": {
|
|
580
|
+
"oneOf": [
|
|
581
|
+
{
|
|
582
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"$ref": "#/components/schemas/InvalidApiFilterErrorResponse"
|
|
589
|
+
}
|
|
590
|
+
]
|
|
591
|
+
}
|
|
592
|
+
}
|
|
593
|
+
}
|
|
594
|
+
},
|
|
595
|
+
"401": {
|
|
596
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
597
|
+
"content": {
|
|
598
|
+
"application/problem+json": {
|
|
599
|
+
"schema": {
|
|
600
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
601
|
+
}
|
|
602
|
+
}
|
|
603
|
+
}
|
|
604
|
+
},
|
|
605
|
+
"403": {
|
|
606
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
607
|
+
"content": {
|
|
608
|
+
"application/problem+json": {
|
|
609
|
+
"schema": {
|
|
610
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
611
|
+
}
|
|
612
|
+
}
|
|
613
|
+
}
|
|
614
|
+
},
|
|
615
|
+
"404": {
|
|
616
|
+
"description": "Metrics category not available for the organization",
|
|
617
|
+
"content": {
|
|
618
|
+
"application/problem+json": {
|
|
619
|
+
"schema": {
|
|
620
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
621
|
+
}
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
"503": {
|
|
626
|
+
"description": "Metrics data temporarily unavailable",
|
|
627
|
+
"content": {
|
|
628
|
+
"application/problem+json": {
|
|
629
|
+
"schema": {
|
|
630
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
631
|
+
}
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
}
|
|
635
|
+
},
|
|
636
|
+
"security": [
|
|
637
|
+
{
|
|
638
|
+
"AmOAuth2": [
|
|
639
|
+
"sfcc.metrics"
|
|
640
|
+
]
|
|
641
|
+
}
|
|
642
|
+
]
|
|
643
|
+
}
|
|
644
|
+
},
|
|
645
|
+
"/organizations/{organizationId}/metrics/scapi-hooks": {
|
|
646
|
+
"get": {
|
|
647
|
+
"operationId": "getScapiHooksMetrics",
|
|
648
|
+
"parameters": [
|
|
649
|
+
{
|
|
650
|
+
"name": "organizationId",
|
|
651
|
+
"in": "path",
|
|
652
|
+
"required": true,
|
|
653
|
+
"style": "simple",
|
|
654
|
+
"explode": false,
|
|
655
|
+
"schema": {
|
|
656
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
657
|
+
}
|
|
658
|
+
},
|
|
659
|
+
{
|
|
660
|
+
"name": "from",
|
|
661
|
+
"in": "query",
|
|
662
|
+
"required": false,
|
|
663
|
+
"style": "form",
|
|
664
|
+
"explode": true,
|
|
665
|
+
"schema": {
|
|
666
|
+
"type": "integer",
|
|
667
|
+
"format": "int64",
|
|
668
|
+
"minimum": 1
|
|
669
|
+
}
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
"name": "to",
|
|
673
|
+
"in": "query",
|
|
674
|
+
"required": false,
|
|
675
|
+
"style": "form",
|
|
676
|
+
"explode": true,
|
|
677
|
+
"schema": {
|
|
678
|
+
"type": "integer",
|
|
679
|
+
"format": "int64",
|
|
680
|
+
"minimum": 1
|
|
681
|
+
}
|
|
682
|
+
}
|
|
683
|
+
],
|
|
684
|
+
"responses": {
|
|
685
|
+
"200": {
|
|
686
|
+
"description": "Successfully retrieved SCAPI hooks metrics for the requested time window",
|
|
687
|
+
"content": {
|
|
688
|
+
"application/json": {
|
|
689
|
+
"schema": {
|
|
690
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
691
|
+
}
|
|
692
|
+
}
|
|
693
|
+
}
|
|
694
|
+
},
|
|
695
|
+
"400": {
|
|
696
|
+
"description": "Bad request — invalid time parameters",
|
|
697
|
+
"content": {
|
|
698
|
+
"application/problem+json": {
|
|
699
|
+
"schema": {
|
|
700
|
+
"oneOf": [
|
|
701
|
+
{
|
|
702
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
706
|
+
}
|
|
707
|
+
]
|
|
708
|
+
}
|
|
709
|
+
}
|
|
710
|
+
}
|
|
711
|
+
},
|
|
712
|
+
"401": {
|
|
713
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
714
|
+
"content": {
|
|
715
|
+
"application/problem+json": {
|
|
716
|
+
"schema": {
|
|
717
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
}
|
|
721
|
+
},
|
|
722
|
+
"403": {
|
|
723
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
724
|
+
"content": {
|
|
725
|
+
"application/problem+json": {
|
|
726
|
+
"schema": {
|
|
727
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
728
|
+
}
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
},
|
|
732
|
+
"404": {
|
|
733
|
+
"description": "Metrics category not available for the organization",
|
|
734
|
+
"content": {
|
|
735
|
+
"application/problem+json": {
|
|
736
|
+
"schema": {
|
|
737
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
738
|
+
}
|
|
739
|
+
}
|
|
740
|
+
}
|
|
741
|
+
},
|
|
742
|
+
"503": {
|
|
743
|
+
"description": "Metrics data temporarily unavailable",
|
|
744
|
+
"content": {
|
|
745
|
+
"application/problem+json": {
|
|
746
|
+
"schema": {
|
|
747
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
748
|
+
}
|
|
749
|
+
}
|
|
750
|
+
}
|
|
751
|
+
}
|
|
752
|
+
},
|
|
753
|
+
"security": [
|
|
754
|
+
{
|
|
755
|
+
"AmOAuth2": [
|
|
756
|
+
"sfcc.metrics"
|
|
757
|
+
]
|
|
758
|
+
}
|
|
759
|
+
]
|
|
760
|
+
}
|
|
761
|
+
},
|
|
762
|
+
"/organizations/{organizationId}/metrics/mrt": {
|
|
763
|
+
"get": {
|
|
764
|
+
"operationId": "getMrtMetrics",
|
|
765
|
+
"parameters": [
|
|
766
|
+
{
|
|
767
|
+
"name": "organizationId",
|
|
768
|
+
"in": "path",
|
|
769
|
+
"required": true,
|
|
770
|
+
"style": "simple",
|
|
771
|
+
"explode": false,
|
|
772
|
+
"schema": {
|
|
773
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
774
|
+
}
|
|
775
|
+
},
|
|
776
|
+
{
|
|
777
|
+
"name": "from",
|
|
778
|
+
"in": "query",
|
|
779
|
+
"required": false,
|
|
780
|
+
"style": "form",
|
|
781
|
+
"explode": true,
|
|
782
|
+
"schema": {
|
|
783
|
+
"type": "integer",
|
|
784
|
+
"format": "int64",
|
|
785
|
+
"minimum": 1
|
|
786
|
+
}
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"name": "to",
|
|
790
|
+
"in": "query",
|
|
791
|
+
"required": false,
|
|
792
|
+
"style": "form",
|
|
793
|
+
"explode": true,
|
|
794
|
+
"schema": {
|
|
795
|
+
"type": "integer",
|
|
796
|
+
"format": "int64",
|
|
797
|
+
"minimum": 1
|
|
798
|
+
}
|
|
799
|
+
}
|
|
800
|
+
],
|
|
801
|
+
"responses": {
|
|
802
|
+
"200": {
|
|
803
|
+
"description": "Successfully retrieved Managed Runtime metrics for the requested time window",
|
|
804
|
+
"content": {
|
|
805
|
+
"application/json": {
|
|
806
|
+
"schema": {
|
|
807
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
808
|
+
}
|
|
809
|
+
}
|
|
810
|
+
}
|
|
811
|
+
},
|
|
812
|
+
"400": {
|
|
813
|
+
"description": "Bad request — invalid time parameters",
|
|
814
|
+
"content": {
|
|
815
|
+
"application/problem+json": {
|
|
816
|
+
"schema": {
|
|
817
|
+
"oneOf": [
|
|
818
|
+
{
|
|
819
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
823
|
+
}
|
|
824
|
+
]
|
|
825
|
+
}
|
|
826
|
+
}
|
|
827
|
+
}
|
|
828
|
+
},
|
|
829
|
+
"401": {
|
|
830
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
831
|
+
"content": {
|
|
832
|
+
"application/problem+json": {
|
|
833
|
+
"schema": {
|
|
834
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
835
|
+
}
|
|
836
|
+
}
|
|
837
|
+
}
|
|
838
|
+
},
|
|
839
|
+
"403": {
|
|
840
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
841
|
+
"content": {
|
|
842
|
+
"application/problem+json": {
|
|
843
|
+
"schema": {
|
|
844
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
845
|
+
}
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
},
|
|
849
|
+
"404": {
|
|
850
|
+
"description": "Metrics category not available for the organization",
|
|
851
|
+
"content": {
|
|
852
|
+
"application/problem+json": {
|
|
853
|
+
"schema": {
|
|
854
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
}
|
|
858
|
+
},
|
|
859
|
+
"503": {
|
|
860
|
+
"description": "Metrics data temporarily unavailable",
|
|
861
|
+
"content": {
|
|
862
|
+
"application/problem+json": {
|
|
863
|
+
"schema": {
|
|
864
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
865
|
+
}
|
|
866
|
+
}
|
|
867
|
+
}
|
|
868
|
+
}
|
|
869
|
+
},
|
|
870
|
+
"security": [
|
|
871
|
+
{
|
|
872
|
+
"AmOAuth2": [
|
|
873
|
+
"sfcc.metrics"
|
|
874
|
+
]
|
|
875
|
+
}
|
|
876
|
+
]
|
|
877
|
+
}
|
|
878
|
+
},
|
|
879
|
+
"/organizations/{organizationId}/metrics/controller": {
|
|
880
|
+
"get": {
|
|
881
|
+
"operationId": "getControllerMetrics",
|
|
882
|
+
"parameters": [
|
|
883
|
+
{
|
|
884
|
+
"name": "organizationId",
|
|
885
|
+
"in": "path",
|
|
886
|
+
"required": true,
|
|
887
|
+
"style": "simple",
|
|
888
|
+
"explode": false,
|
|
889
|
+
"schema": {
|
|
890
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
891
|
+
}
|
|
892
|
+
},
|
|
893
|
+
{
|
|
894
|
+
"name": "from",
|
|
895
|
+
"in": "query",
|
|
896
|
+
"required": false,
|
|
897
|
+
"style": "form",
|
|
898
|
+
"explode": true,
|
|
899
|
+
"schema": {
|
|
900
|
+
"type": "integer",
|
|
901
|
+
"format": "int64",
|
|
902
|
+
"minimum": 1
|
|
903
|
+
}
|
|
904
|
+
},
|
|
905
|
+
{
|
|
906
|
+
"name": "to",
|
|
907
|
+
"in": "query",
|
|
908
|
+
"required": false,
|
|
909
|
+
"style": "form",
|
|
910
|
+
"explode": true,
|
|
911
|
+
"schema": {
|
|
912
|
+
"type": "integer",
|
|
913
|
+
"format": "int64",
|
|
914
|
+
"minimum": 1
|
|
915
|
+
}
|
|
916
|
+
}
|
|
917
|
+
],
|
|
918
|
+
"responses": {
|
|
919
|
+
"200": {
|
|
920
|
+
"description": "Successfully retrieved controller metrics for the requested time window",
|
|
921
|
+
"content": {
|
|
922
|
+
"application/json": {
|
|
923
|
+
"schema": {
|
|
924
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
925
|
+
}
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
},
|
|
929
|
+
"400": {
|
|
930
|
+
"description": "Bad request — invalid time parameters",
|
|
931
|
+
"content": {
|
|
932
|
+
"application/problem+json": {
|
|
933
|
+
"schema": {
|
|
934
|
+
"oneOf": [
|
|
935
|
+
{
|
|
936
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
940
|
+
}
|
|
941
|
+
]
|
|
942
|
+
}
|
|
943
|
+
}
|
|
944
|
+
}
|
|
945
|
+
},
|
|
946
|
+
"401": {
|
|
947
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
948
|
+
"content": {
|
|
949
|
+
"application/problem+json": {
|
|
950
|
+
"schema": {
|
|
951
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
952
|
+
}
|
|
953
|
+
}
|
|
954
|
+
}
|
|
955
|
+
},
|
|
956
|
+
"403": {
|
|
957
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
958
|
+
"content": {
|
|
959
|
+
"application/problem+json": {
|
|
960
|
+
"schema": {
|
|
961
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
962
|
+
}
|
|
963
|
+
}
|
|
964
|
+
}
|
|
965
|
+
},
|
|
966
|
+
"404": {
|
|
967
|
+
"description": "Metrics category not available for the organization",
|
|
968
|
+
"content": {
|
|
969
|
+
"application/problem+json": {
|
|
970
|
+
"schema": {
|
|
971
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
972
|
+
}
|
|
973
|
+
}
|
|
974
|
+
}
|
|
975
|
+
},
|
|
976
|
+
"503": {
|
|
977
|
+
"description": "Metrics data temporarily unavailable",
|
|
978
|
+
"content": {
|
|
979
|
+
"application/problem+json": {
|
|
980
|
+
"schema": {
|
|
981
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
982
|
+
}
|
|
983
|
+
}
|
|
984
|
+
}
|
|
985
|
+
}
|
|
986
|
+
},
|
|
987
|
+
"security": [
|
|
988
|
+
{
|
|
989
|
+
"AmOAuth2": [
|
|
990
|
+
"sfcc.metrics"
|
|
991
|
+
]
|
|
992
|
+
}
|
|
993
|
+
]
|
|
994
|
+
}
|
|
995
|
+
},
|
|
996
|
+
"/organizations/{organizationId}/metrics/ocapi": {
|
|
997
|
+
"get": {
|
|
998
|
+
"operationId": "getOcapiMetrics",
|
|
999
|
+
"parameters": [
|
|
1000
|
+
{
|
|
1001
|
+
"name": "organizationId",
|
|
1002
|
+
"in": "path",
|
|
1003
|
+
"required": true,
|
|
1004
|
+
"style": "simple",
|
|
1005
|
+
"explode": false,
|
|
1006
|
+
"schema": {
|
|
1007
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
1008
|
+
}
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"name": "from",
|
|
1012
|
+
"in": "query",
|
|
1013
|
+
"required": false,
|
|
1014
|
+
"style": "form",
|
|
1015
|
+
"explode": true,
|
|
1016
|
+
"schema": {
|
|
1017
|
+
"type": "integer",
|
|
1018
|
+
"format": "int64",
|
|
1019
|
+
"minimum": 1
|
|
1020
|
+
}
|
|
1021
|
+
},
|
|
1022
|
+
{
|
|
1023
|
+
"name": "to",
|
|
1024
|
+
"in": "query",
|
|
1025
|
+
"required": false,
|
|
1026
|
+
"style": "form",
|
|
1027
|
+
"explode": true,
|
|
1028
|
+
"schema": {
|
|
1029
|
+
"type": "integer",
|
|
1030
|
+
"format": "int64",
|
|
1031
|
+
"minimum": 1
|
|
1032
|
+
}
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"name": "ocapiCategory",
|
|
1036
|
+
"in": "query",
|
|
1037
|
+
"required": false,
|
|
1038
|
+
"style": "form",
|
|
1039
|
+
"explode": true,
|
|
1040
|
+
"schema": {
|
|
1041
|
+
"type": "string",
|
|
1042
|
+
"maxLength": 100,
|
|
1043
|
+
"minLength": 1
|
|
1044
|
+
}
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
"name": "ocapiApi",
|
|
1048
|
+
"in": "query",
|
|
1049
|
+
"required": false,
|
|
1050
|
+
"style": "form",
|
|
1051
|
+
"explode": true,
|
|
1052
|
+
"schema": {
|
|
1053
|
+
"type": "string",
|
|
1054
|
+
"maxLength": 100,
|
|
1055
|
+
"minLength": 1
|
|
1056
|
+
}
|
|
1057
|
+
}
|
|
1058
|
+
],
|
|
1059
|
+
"responses": {
|
|
1060
|
+
"200": {
|
|
1061
|
+
"description": "Successfully retrieved OCAPI metrics for the requested time window",
|
|
1062
|
+
"content": {
|
|
1063
|
+
"application/json": {
|
|
1064
|
+
"schema": {
|
|
1065
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1066
|
+
}
|
|
1067
|
+
}
|
|
1068
|
+
}
|
|
1069
|
+
},
|
|
1070
|
+
"400": {
|
|
1071
|
+
"description": "Bad request — invalid time parameters or OCAPI filter value",
|
|
1072
|
+
"content": {
|
|
1073
|
+
"application/problem+json": {
|
|
1074
|
+
"schema": {
|
|
1075
|
+
"oneOf": [
|
|
1076
|
+
{
|
|
1077
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
1078
|
+
},
|
|
1079
|
+
{
|
|
1080
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"$ref": "#/components/schemas/InvalidApiFilterErrorResponse"
|
|
1084
|
+
}
|
|
1085
|
+
]
|
|
1086
|
+
}
|
|
1087
|
+
}
|
|
1088
|
+
}
|
|
1089
|
+
},
|
|
1090
|
+
"401": {
|
|
1091
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
1092
|
+
"content": {
|
|
1093
|
+
"application/problem+json": {
|
|
1094
|
+
"schema": {
|
|
1095
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1096
|
+
}
|
|
1097
|
+
}
|
|
1098
|
+
}
|
|
1099
|
+
},
|
|
1100
|
+
"403": {
|
|
1101
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
1102
|
+
"content": {
|
|
1103
|
+
"application/problem+json": {
|
|
1104
|
+
"schema": {
|
|
1105
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1106
|
+
}
|
|
1107
|
+
}
|
|
1108
|
+
}
|
|
1109
|
+
},
|
|
1110
|
+
"404": {
|
|
1111
|
+
"description": "Metrics category not available for the organization",
|
|
1112
|
+
"content": {
|
|
1113
|
+
"application/problem+json": {
|
|
1114
|
+
"schema": {
|
|
1115
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
1116
|
+
}
|
|
1117
|
+
}
|
|
1118
|
+
}
|
|
1119
|
+
},
|
|
1120
|
+
"503": {
|
|
1121
|
+
"description": "Metrics data temporarily unavailable",
|
|
1122
|
+
"content": {
|
|
1123
|
+
"application/problem+json": {
|
|
1124
|
+
"schema": {
|
|
1125
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
1126
|
+
}
|
|
1127
|
+
}
|
|
1128
|
+
}
|
|
1129
|
+
}
|
|
1130
|
+
},
|
|
1131
|
+
"security": [
|
|
1132
|
+
{
|
|
1133
|
+
"AmOAuth2": [
|
|
1134
|
+
"sfcc.metrics"
|
|
1135
|
+
]
|
|
1136
|
+
}
|
|
1137
|
+
]
|
|
1138
|
+
}
|
|
1139
|
+
}
|
|
1140
|
+
},
|
|
1141
|
+
"components": {
|
|
1142
|
+
"schemas": {
|
|
1143
|
+
"OrganizationId": {
|
|
1144
|
+
"type": "string",
|
|
1145
|
+
"pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
|
|
1146
|
+
},
|
|
1147
|
+
"MetricId": {
|
|
1148
|
+
"type": "string",
|
|
1149
|
+
"maxLength": 100,
|
|
1150
|
+
"minLength": 1,
|
|
1151
|
+
"pattern": "^[a-zA-Z0-9_-]+$"
|
|
1152
|
+
},
|
|
1153
|
+
"DataSeriesId": {
|
|
1154
|
+
"type": "string",
|
|
1155
|
+
"maxLength": 200,
|
|
1156
|
+
"minLength": 1
|
|
1157
|
+
},
|
|
1158
|
+
"DataPoint": {
|
|
1159
|
+
"type": "object",
|
|
1160
|
+
"properties": {
|
|
1161
|
+
"timestamp": {
|
|
1162
|
+
"type": "integer",
|
|
1163
|
+
"minimum": 0
|
|
1164
|
+
},
|
|
1165
|
+
"value": {
|
|
1166
|
+
"type": "number"
|
|
1167
|
+
}
|
|
1168
|
+
},
|
|
1169
|
+
"required": [
|
|
1170
|
+
"timestamp",
|
|
1171
|
+
"value"
|
|
1172
|
+
]
|
|
1173
|
+
},
|
|
1174
|
+
"DataSeries": {
|
|
1175
|
+
"type": "object",
|
|
1176
|
+
"properties": {
|
|
1177
|
+
"id": {
|
|
1178
|
+
"$ref": "#/components/schemas/DataSeriesId"
|
|
1179
|
+
},
|
|
1180
|
+
"name": {
|
|
1181
|
+
"type": "string",
|
|
1182
|
+
"maxLength": 200,
|
|
1183
|
+
"minLength": 1
|
|
1184
|
+
},
|
|
1185
|
+
"data": {
|
|
1186
|
+
"type": "array",
|
|
1187
|
+
"items": {
|
|
1188
|
+
"$ref": "#/components/schemas/DataPoint"
|
|
1189
|
+
}
|
|
1190
|
+
}
|
|
1191
|
+
},
|
|
1192
|
+
"required": [
|
|
1193
|
+
"data",
|
|
1194
|
+
"id",
|
|
1195
|
+
"name"
|
|
1196
|
+
]
|
|
1197
|
+
},
|
|
1198
|
+
"Metric": {
|
|
1199
|
+
"type": "object",
|
|
1200
|
+
"properties": {
|
|
1201
|
+
"metricId": {
|
|
1202
|
+
"$ref": "#/components/schemas/MetricId"
|
|
1203
|
+
},
|
|
1204
|
+
"title": {
|
|
1205
|
+
"type": "string",
|
|
1206
|
+
"maxLength": 200,
|
|
1207
|
+
"minLength": 1
|
|
1208
|
+
},
|
|
1209
|
+
"description": {
|
|
1210
|
+
"type": "string",
|
|
1211
|
+
"maxLength": 500,
|
|
1212
|
+
"minLength": 1
|
|
1213
|
+
},
|
|
1214
|
+
"unit": {
|
|
1215
|
+
"type": "string",
|
|
1216
|
+
"maxLength": 50,
|
|
1217
|
+
"minLength": 0
|
|
1218
|
+
},
|
|
1219
|
+
"dataSeries": {
|
|
1220
|
+
"type": "array",
|
|
1221
|
+
"items": {
|
|
1222
|
+
"$ref": "#/components/schemas/DataSeries"
|
|
1223
|
+
}
|
|
1224
|
+
}
|
|
1225
|
+
},
|
|
1226
|
+
"required": [
|
|
1227
|
+
"dataSeries",
|
|
1228
|
+
"description",
|
|
1229
|
+
"metricId",
|
|
1230
|
+
"title"
|
|
1231
|
+
]
|
|
1232
|
+
},
|
|
1233
|
+
"MetricsDataResponse": {
|
|
1234
|
+
"type": "object",
|
|
1235
|
+
"additionalProperties": false,
|
|
1236
|
+
"properties": {
|
|
1237
|
+
"data": {
|
|
1238
|
+
"type": "array",
|
|
1239
|
+
"items": {
|
|
1240
|
+
"$ref": "#/components/schemas/Metric"
|
|
1241
|
+
}
|
|
1242
|
+
}
|
|
1243
|
+
},
|
|
1244
|
+
"required": [
|
|
1245
|
+
"data"
|
|
1246
|
+
]
|
|
1247
|
+
},
|
|
1248
|
+
"ErrorResponse": {
|
|
1249
|
+
"type": "object",
|
|
1250
|
+
"additionalProperties": true,
|
|
1251
|
+
"properties": {
|
|
1252
|
+
"title": {
|
|
1253
|
+
"type": "string",
|
|
1254
|
+
"maxLength": 256
|
|
1255
|
+
},
|
|
1256
|
+
"type": {
|
|
1257
|
+
"type": "string",
|
|
1258
|
+
"maxLength": 2048
|
|
1259
|
+
},
|
|
1260
|
+
"detail": {
|
|
1261
|
+
"type": "string"
|
|
1262
|
+
},
|
|
1263
|
+
"instance": {
|
|
1264
|
+
"type": "string",
|
|
1265
|
+
"maxLength": 2048
|
|
1266
|
+
}
|
|
1267
|
+
},
|
|
1268
|
+
"required": [
|
|
1269
|
+
"detail",
|
|
1270
|
+
"title",
|
|
1271
|
+
"type"
|
|
1272
|
+
]
|
|
1273
|
+
},
|
|
1274
|
+
"InvalidTimeParameterErrorResponse": {
|
|
1275
|
+
"allOf": [
|
|
1276
|
+
{
|
|
1277
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1278
|
+
}
|
|
1279
|
+
],
|
|
1280
|
+
"properties": {
|
|
1281
|
+
"parameter": {
|
|
1282
|
+
"type": "string",
|
|
1283
|
+
"maxLength": 100
|
|
1284
|
+
}
|
|
1285
|
+
},
|
|
1286
|
+
"required": [
|
|
1287
|
+
"parameter"
|
|
1288
|
+
]
|
|
1289
|
+
},
|
|
1290
|
+
"InvalidTimeRangeErrorResponse": {
|
|
1291
|
+
"allOf": [
|
|
1292
|
+
{
|
|
1293
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1294
|
+
}
|
|
1295
|
+
],
|
|
1296
|
+
"properties": {
|
|
1297
|
+
"fromValue": {
|
|
1298
|
+
"type": "integer",
|
|
1299
|
+
"format": "int64"
|
|
1300
|
+
},
|
|
1301
|
+
"toValue": {
|
|
1302
|
+
"type": "integer",
|
|
1303
|
+
"format": "int64"
|
|
1304
|
+
}
|
|
1305
|
+
},
|
|
1306
|
+
"required": [
|
|
1307
|
+
"fromValue",
|
|
1308
|
+
"toValue"
|
|
1309
|
+
]
|
|
1310
|
+
},
|
|
1311
|
+
"CategoryNotFoundErrorResponse": {
|
|
1312
|
+
"allOf": [
|
|
1313
|
+
{
|
|
1314
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1315
|
+
}
|
|
1316
|
+
],
|
|
1317
|
+
"properties": {
|
|
1318
|
+
"category": {
|
|
1319
|
+
"type": "string",
|
|
1320
|
+
"maxLength": 50
|
|
1321
|
+
},
|
|
1322
|
+
"organizationId": {
|
|
1323
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
1324
|
+
}
|
|
1325
|
+
}
|
|
1326
|
+
},
|
|
1327
|
+
"MetricsNotAvailableErrorResponse": {
|
|
1328
|
+
"allOf": [
|
|
1329
|
+
{
|
|
1330
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1331
|
+
}
|
|
1332
|
+
],
|
|
1333
|
+
"properties": {
|
|
1334
|
+
"organizationId": {
|
|
1335
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
1336
|
+
}
|
|
1337
|
+
}
|
|
1338
|
+
},
|
|
1339
|
+
"ThirdPartyServiceId": {
|
|
1340
|
+
"type": "string",
|
|
1341
|
+
"maxLength": 255,
|
|
1342
|
+
"minLength": 1
|
|
1343
|
+
},
|
|
1344
|
+
"InvalidThirdPartyServiceErrorResponse": {
|
|
1345
|
+
"allOf": [
|
|
1346
|
+
{
|
|
1347
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1348
|
+
}
|
|
1349
|
+
],
|
|
1350
|
+
"properties": {
|
|
1351
|
+
"thirdPartyServiceId": {
|
|
1352
|
+
"$ref": "#/components/schemas/ThirdPartyServiceId"
|
|
1353
|
+
},
|
|
1354
|
+
"organizationId": {
|
|
1355
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
1356
|
+
}
|
|
1357
|
+
},
|
|
1358
|
+
"required": [
|
|
1359
|
+
"organizationId",
|
|
1360
|
+
"thirdPartyServiceId"
|
|
1361
|
+
]
|
|
1362
|
+
},
|
|
1363
|
+
"InvalidApiFilterErrorResponse": {
|
|
1364
|
+
"allOf": [
|
|
1365
|
+
{
|
|
1366
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1367
|
+
}
|
|
1368
|
+
],
|
|
1369
|
+
"properties": {
|
|
1370
|
+
"filterName": {
|
|
1371
|
+
"type": "string",
|
|
1372
|
+
"maxLength": 100
|
|
1373
|
+
},
|
|
1374
|
+
"filterValue": {
|
|
1375
|
+
"type": "string",
|
|
1376
|
+
"maxLength": 100
|
|
1377
|
+
}
|
|
1378
|
+
},
|
|
1379
|
+
"required": [
|
|
1380
|
+
"filterName",
|
|
1381
|
+
"filterValue"
|
|
1382
|
+
]
|
|
1383
|
+
}
|
|
1384
|
+
},
|
|
1385
|
+
"responses": {
|
|
1386
|
+
"OverallMetricsResponse": {
|
|
1387
|
+
"description": "Successfully retrieved overall application metrics for the requested time window",
|
|
1388
|
+
"content": {
|
|
1389
|
+
"application/json": {
|
|
1390
|
+
"schema": {
|
|
1391
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1392
|
+
}
|
|
1393
|
+
}
|
|
1394
|
+
}
|
|
1395
|
+
},
|
|
1396
|
+
"BadRequestTimeResponse": {
|
|
1397
|
+
"description": "Bad request — invalid time parameters",
|
|
1398
|
+
"content": {
|
|
1399
|
+
"application/problem+json": {
|
|
1400
|
+
"schema": {
|
|
1401
|
+
"oneOf": [
|
|
1402
|
+
{
|
|
1403
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
1404
|
+
},
|
|
1405
|
+
{
|
|
1406
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
1407
|
+
}
|
|
1408
|
+
]
|
|
1409
|
+
}
|
|
1410
|
+
}
|
|
1411
|
+
}
|
|
1412
|
+
},
|
|
1413
|
+
"401unauthorized": {
|
|
1414
|
+
"description": "Your access token is invalid or expired and can’t be used to identify a user.",
|
|
1415
|
+
"content": {
|
|
1416
|
+
"application/problem+json": {
|
|
1417
|
+
"schema": {
|
|
1418
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1419
|
+
}
|
|
1420
|
+
}
|
|
1421
|
+
}
|
|
1422
|
+
},
|
|
1423
|
+
"403forbidden": {
|
|
1424
|
+
"description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
|
|
1425
|
+
"content": {
|
|
1426
|
+
"application/problem+json": {
|
|
1427
|
+
"schema": {
|
|
1428
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
1429
|
+
}
|
|
1430
|
+
}
|
|
1431
|
+
}
|
|
1432
|
+
},
|
|
1433
|
+
"CategoryNotFoundResponse": {
|
|
1434
|
+
"description": "Metrics category not available for the organization",
|
|
1435
|
+
"content": {
|
|
1436
|
+
"application/problem+json": {
|
|
1437
|
+
"schema": {
|
|
1438
|
+
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
1439
|
+
}
|
|
1440
|
+
}
|
|
1441
|
+
}
|
|
1442
|
+
},
|
|
1443
|
+
"ServiceUnavailableResponse": {
|
|
1444
|
+
"description": "Metrics data temporarily unavailable",
|
|
1445
|
+
"content": {
|
|
1446
|
+
"application/problem+json": {
|
|
1447
|
+
"schema": {
|
|
1448
|
+
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
1449
|
+
}
|
|
1450
|
+
}
|
|
1451
|
+
}
|
|
1452
|
+
},
|
|
1453
|
+
"SalesMetricsResponse": {
|
|
1454
|
+
"description": "Successfully retrieved sales metrics for the requested time window",
|
|
1455
|
+
"content": {
|
|
1456
|
+
"application/json": {
|
|
1457
|
+
"schema": {
|
|
1458
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1459
|
+
}
|
|
1460
|
+
}
|
|
1461
|
+
}
|
|
1462
|
+
},
|
|
1463
|
+
"EcdnMetricsResponse": {
|
|
1464
|
+
"description": "Successfully retrieved eCDN metrics for the requested time window",
|
|
1465
|
+
"content": {
|
|
1466
|
+
"application/json": {
|
|
1467
|
+
"schema": {
|
|
1468
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1469
|
+
}
|
|
1470
|
+
}
|
|
1471
|
+
}
|
|
1472
|
+
},
|
|
1473
|
+
"ThirdPartyMetricsResponse": {
|
|
1474
|
+
"description": "Successfully retrieved third party service metrics for the requested time window",
|
|
1475
|
+
"content": {
|
|
1476
|
+
"application/json": {
|
|
1477
|
+
"schema": {
|
|
1478
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1479
|
+
}
|
|
1480
|
+
}
|
|
1481
|
+
}
|
|
1482
|
+
},
|
|
1483
|
+
"BadRequestThirdPartyResponse": {
|
|
1484
|
+
"description": "Bad request — invalid time parameters or third party service filter",
|
|
1485
|
+
"content": {
|
|
1486
|
+
"application/problem+json": {
|
|
1487
|
+
"schema": {
|
|
1488
|
+
"oneOf": [
|
|
1489
|
+
{
|
|
1490
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
1491
|
+
},
|
|
1492
|
+
{
|
|
1493
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
1494
|
+
},
|
|
1495
|
+
{
|
|
1496
|
+
"$ref": "#/components/schemas/InvalidThirdPartyServiceErrorResponse"
|
|
1497
|
+
}
|
|
1498
|
+
]
|
|
1499
|
+
}
|
|
1500
|
+
}
|
|
1501
|
+
}
|
|
1502
|
+
},
|
|
1503
|
+
"ScapiMetricsResponse": {
|
|
1504
|
+
"description": "Successfully retrieved SCAPI metrics for the requested time window",
|
|
1505
|
+
"content": {
|
|
1506
|
+
"application/json": {
|
|
1507
|
+
"schema": {
|
|
1508
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1509
|
+
}
|
|
1510
|
+
}
|
|
1511
|
+
}
|
|
1512
|
+
},
|
|
1513
|
+
"BadRequestScapiResponse": {
|
|
1514
|
+
"description": "Bad request — invalid time parameters or SCAPI filter value",
|
|
1515
|
+
"content": {
|
|
1516
|
+
"application/problem+json": {
|
|
1517
|
+
"schema": {
|
|
1518
|
+
"oneOf": [
|
|
1519
|
+
{
|
|
1520
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
"$ref": "#/components/schemas/InvalidApiFilterErrorResponse"
|
|
1527
|
+
}
|
|
1528
|
+
]
|
|
1529
|
+
}
|
|
1530
|
+
}
|
|
1531
|
+
}
|
|
1532
|
+
},
|
|
1533
|
+
"ScapiHooksMetricsResponse": {
|
|
1534
|
+
"description": "Successfully retrieved SCAPI hooks metrics for the requested time window",
|
|
1535
|
+
"content": {
|
|
1536
|
+
"application/json": {
|
|
1537
|
+
"schema": {
|
|
1538
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1539
|
+
}
|
|
1540
|
+
}
|
|
1541
|
+
}
|
|
1542
|
+
},
|
|
1543
|
+
"MrtMetricsResponse": {
|
|
1544
|
+
"description": "Successfully retrieved Managed Runtime metrics for the requested time window",
|
|
1545
|
+
"content": {
|
|
1546
|
+
"application/json": {
|
|
1547
|
+
"schema": {
|
|
1548
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1549
|
+
}
|
|
1550
|
+
}
|
|
1551
|
+
}
|
|
1552
|
+
},
|
|
1553
|
+
"ControllerMetricsResponse": {
|
|
1554
|
+
"description": "Successfully retrieved controller metrics for the requested time window",
|
|
1555
|
+
"content": {
|
|
1556
|
+
"application/json": {
|
|
1557
|
+
"schema": {
|
|
1558
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1559
|
+
}
|
|
1560
|
+
}
|
|
1561
|
+
}
|
|
1562
|
+
},
|
|
1563
|
+
"OcapiMetricsResponse": {
|
|
1564
|
+
"description": "Successfully retrieved OCAPI metrics for the requested time window",
|
|
1565
|
+
"content": {
|
|
1566
|
+
"application/json": {
|
|
1567
|
+
"schema": {
|
|
1568
|
+
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1569
|
+
}
|
|
1570
|
+
}
|
|
1571
|
+
}
|
|
1572
|
+
},
|
|
1573
|
+
"BadRequestOcapiResponse": {
|
|
1574
|
+
"description": "Bad request — invalid time parameters or OCAPI filter value",
|
|
1575
|
+
"content": {
|
|
1576
|
+
"application/problem+json": {
|
|
1577
|
+
"schema": {
|
|
1578
|
+
"oneOf": [
|
|
1579
|
+
{
|
|
1580
|
+
"$ref": "#/components/schemas/InvalidTimeParameterErrorResponse"
|
|
1581
|
+
},
|
|
1582
|
+
{
|
|
1583
|
+
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
1584
|
+
},
|
|
1585
|
+
{
|
|
1586
|
+
"$ref": "#/components/schemas/InvalidApiFilterErrorResponse"
|
|
1587
|
+
}
|
|
1588
|
+
]
|
|
1589
|
+
}
|
|
1590
|
+
}
|
|
1591
|
+
}
|
|
1592
|
+
}
|
|
1593
|
+
},
|
|
1594
|
+
"parameters": {
|
|
1595
|
+
"organizationId": {
|
|
1596
|
+
"name": "organizationId",
|
|
1597
|
+
"in": "path",
|
|
1598
|
+
"required": true,
|
|
1599
|
+
"style": "simple",
|
|
1600
|
+
"explode": false,
|
|
1601
|
+
"schema": {
|
|
1602
|
+
"$ref": "#/components/schemas/OrganizationId"
|
|
1603
|
+
}
|
|
1604
|
+
},
|
|
1605
|
+
"from": {
|
|
1606
|
+
"name": "from",
|
|
1607
|
+
"in": "query",
|
|
1608
|
+
"required": false,
|
|
1609
|
+
"style": "form",
|
|
1610
|
+
"explode": true,
|
|
1611
|
+
"schema": {
|
|
1612
|
+
"type": "integer",
|
|
1613
|
+
"format": "int64",
|
|
1614
|
+
"minimum": 1
|
|
1615
|
+
}
|
|
1616
|
+
},
|
|
1617
|
+
"to": {
|
|
1618
|
+
"name": "to",
|
|
1619
|
+
"in": "query",
|
|
1620
|
+
"required": false,
|
|
1621
|
+
"style": "form",
|
|
1622
|
+
"explode": true,
|
|
1623
|
+
"schema": {
|
|
1624
|
+
"type": "integer",
|
|
1625
|
+
"format": "int64",
|
|
1626
|
+
"minimum": 1
|
|
1627
|
+
}
|
|
1628
|
+
},
|
|
1629
|
+
"thirdPartyServiceId": {
|
|
1630
|
+
"name": "thirdPartyServiceId",
|
|
1631
|
+
"in": "query",
|
|
1632
|
+
"required": false,
|
|
1633
|
+
"style": "form",
|
|
1634
|
+
"explode": true,
|
|
1635
|
+
"schema": {
|
|
1636
|
+
"$ref": "#/components/schemas/ThirdPartyServiceId"
|
|
1637
|
+
}
|
|
1638
|
+
},
|
|
1639
|
+
"apiFamily": {
|
|
1640
|
+
"name": "apiFamily",
|
|
1641
|
+
"in": "query",
|
|
1642
|
+
"required": false,
|
|
1643
|
+
"style": "form",
|
|
1644
|
+
"explode": true,
|
|
1645
|
+
"schema": {
|
|
1646
|
+
"type": "string",
|
|
1647
|
+
"maxLength": 100,
|
|
1648
|
+
"minLength": 1
|
|
1649
|
+
}
|
|
1650
|
+
},
|
|
1651
|
+
"apiName": {
|
|
1652
|
+
"name": "apiName",
|
|
1653
|
+
"in": "query",
|
|
1654
|
+
"required": false,
|
|
1655
|
+
"style": "form",
|
|
1656
|
+
"explode": true,
|
|
1657
|
+
"schema": {
|
|
1658
|
+
"type": "string",
|
|
1659
|
+
"maxLength": 100,
|
|
1660
|
+
"minLength": 1
|
|
1661
|
+
}
|
|
1662
|
+
},
|
|
1663
|
+
"ocapiCategory": {
|
|
1664
|
+
"name": "ocapiCategory",
|
|
1665
|
+
"in": "query",
|
|
1666
|
+
"required": false,
|
|
1667
|
+
"style": "form",
|
|
1668
|
+
"explode": true,
|
|
1669
|
+
"schema": {
|
|
1670
|
+
"type": "string",
|
|
1671
|
+
"maxLength": 100,
|
|
1672
|
+
"minLength": 1
|
|
1673
|
+
}
|
|
1674
|
+
},
|
|
1675
|
+
"ocapiApi": {
|
|
1676
|
+
"name": "ocapiApi",
|
|
1677
|
+
"in": "query",
|
|
1678
|
+
"required": false,
|
|
1679
|
+
"style": "form",
|
|
1680
|
+
"explode": true,
|
|
1681
|
+
"schema": {
|
|
1682
|
+
"type": "string",
|
|
1683
|
+
"maxLength": 100,
|
|
1684
|
+
"minLength": 1
|
|
1685
|
+
}
|
|
1686
|
+
}
|
|
1687
|
+
},
|
|
1688
|
+
"securitySchemes": {
|
|
1689
|
+
"AmOAuth2": {
|
|
1690
|
+
"type": "oauth2",
|
|
1691
|
+
"flows": {
|
|
1692
|
+
"clientCredentials": {
|
|
1693
|
+
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
1694
|
+
"scopes": {
|
|
1695
|
+
"c.example": "custom scopes mus start with c. used for custom APIs [MAX length of scope 49 characters]",
|
|
1696
|
+
"sfcc.example": "standard salesforce commerce apis scopes must start with \"sfcc.\". Without suffix \".rw\" scopes grants READONLY access. [MAX length of scope 49 characters]",
|
|
1697
|
+
"sfcc.example.rw": "salesforce commerce apis scopes must start with \"sfcc.\". The suffix \".rw\" scopes grants READ and WRITE access. [MAX length of scope 49 characters]"
|
|
1698
|
+
}
|
|
1699
|
+
},
|
|
1700
|
+
"authorizationCode": {
|
|
1701
|
+
"authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
|
|
1702
|
+
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
1703
|
+
"scopes": {
|
|
1704
|
+
"c.example": "custom scopes mus start with c. used for custom APIs [MAX length of scope 49 characters]",
|
|
1705
|
+
"sfcc.example": "standard salesforce commerce apis scopes must start with \"sfcc.\". Without suffix \".rw\" scopes grants READONLY access. [MAX length of scope 49 characters]",
|
|
1706
|
+
"sfcc.example.rw": "salesforce commerce apis scopes must start with \"sfcc.\". The suffix \".rw\" scopes grants READ and WRITE access. [MAX length of scope 49 characters]"
|
|
1707
|
+
}
|
|
1708
|
+
}
|
|
1709
|
+
}
|
|
1710
|
+
}
|
|
1711
|
+
}
|
|
1712
|
+
}
|
|
1713
|
+
}
|