@salesforce/b2c-tooling-sdk 2.3.0 → 2.5.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/data/guides/enrichment.json +291 -0
- package/data/guides/index.json +426 -37
- package/data/schemas/dw.schema.json +590 -0
- package/data/tooling/index.json +18 -9
- package/dist/esm/cli/base-command.d.ts +20 -1
- package/dist/esm/cli/base-command.js +61 -11
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/cli/cartridge-command.js +2 -1
- package/dist/esm/cli/cartridge-command.js.map +1 -1
- package/dist/esm/cli/command-search.d.ts +85 -0
- package/dist/esm/cli/command-search.js +147 -0
- package/dist/esm/cli/command-search.js.map +1 -0
- package/dist/esm/cli/config.d.ts +10 -1
- package/dist/esm/cli/config.js +18 -9
- package/dist/esm/cli/config.js.map +1 -1
- package/dist/esm/cli/hooks.d.ts +13 -0
- package/dist/esm/cli/hooks.js +11 -0
- package/dist/esm/cli/hooks.js.map +1 -1
- package/dist/esm/cli/index.d.ts +2 -0
- package/dist/esm/cli/index.js +2 -0
- package/dist/esm/cli/index.js.map +1 -1
- package/dist/esm/cli/instance-command.d.ts +1 -0
- package/dist/esm/cli/instance-command.js +2 -1
- package/dist/esm/cli/instance-command.js.map +1 -1
- package/dist/esm/cli/mrt-command.d.ts +3 -2
- package/dist/esm/cli/mrt-command.js +4 -4
- package/dist/esm/cli/mrt-command.js.map +1 -1
- package/dist/esm/cli/oauth-command.d.ts +1 -0
- package/dist/esm/cli/ods-command.d.ts +1 -0
- package/dist/esm/cli/webdav-command.d.ts +1 -0
- package/dist/esm/clients/custom-apis.d.ts +36 -2
- package/dist/esm/clients/custom-apis.js +57 -4
- package/dist/esm/clients/custom-apis.js.map +1 -1
- package/dist/esm/clients/index.d.ts +1 -1
- package/dist/esm/clients/index.js +1 -1
- package/dist/esm/clients/index.js.map +1 -1
- package/dist/esm/clients/scapi-backend-utils.d.ts +15 -0
- package/dist/esm/clients/scapi-backend-utils.js +28 -1
- package/dist/esm/clients/scapi-backend-utils.js.map +1 -1
- package/dist/esm/clients/scapi-fallback-backend.js +2 -2
- package/dist/esm/clients/scapi-fallback-backend.js.map +1 -1
- package/dist/esm/clients/scapi-schemas.generated.d.ts +2 -2
- package/dist/esm/compat/dispatcher.js +2 -2
- package/dist/esm/compat/dispatcher.js.map +1 -1
- package/dist/esm/config/config-origins.d.ts +19 -0
- package/dist/esm/config/config-origins.js +11 -0
- package/dist/esm/config/config-origins.js.map +1 -0
- package/dist/esm/config/config-write.d.ts +86 -0
- package/dist/esm/config/config-write.js +296 -0
- package/dist/esm/config/config-write.js.map +1 -0
- package/dist/esm/config/dw-json-schema.d.ts +14 -0
- package/dist/esm/config/dw-json-schema.js +269 -0
- package/dist/esm/config/dw-json-schema.js.map +1 -0
- package/dist/esm/config/dw-json.d.ts +2 -0
- package/dist/esm/config/dw-json.js +10 -6
- package/dist/esm/config/dw-json.js.map +1 -1
- package/dist/esm/config/index.d.ts +13 -4
- package/dist/esm/config/index.js +8 -3
- package/dist/esm/config/index.js.map +1 -1
- package/dist/esm/config/instance-manager.d.ts +64 -28
- package/dist/esm/config/instance-manager.js +145 -63
- package/dist/esm/config/instance-manager.js.map +1 -1
- package/dist/esm/config/mapping.d.ts +5 -0
- package/dist/esm/config/mapping.js +20 -1
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/project-environment.d.ts +62 -0
- package/dist/esm/config/project-environment.js +113 -0
- package/dist/esm/config/project-environment.js.map +1 -1
- package/dist/esm/config/resolver.d.ts +22 -0
- package/dist/esm/config/resolver.js +106 -37
- package/dist/esm/config/resolver.js.map +1 -1
- package/dist/esm/config/sources/dw-json-source.d.ts +9 -1
- package/dist/esm/config/sources/dw-json-source.js +59 -23
- package/dist/esm/config/sources/dw-json-source.js.map +1 -1
- package/dist/esm/config/sources/env-source.d.ts +70 -9
- package/dist/esm/config/sources/env-source.js +205 -47
- package/dist/esm/config/sources/env-source.js.map +1 -1
- package/dist/esm/config/sources/index.d.ts +1 -1
- package/dist/esm/config/sources/index.js +1 -1
- package/dist/esm/config/sources/index.js.map +1 -1
- package/dist/esm/config/types.d.ts +53 -3
- package/dist/esm/docs/search.js +3 -1
- package/dist/esm/docs/search.js.map +1 -1
- package/dist/esm/docs/types.d.ts +3 -1
- package/dist/esm/guidance/bundle.d.ts +33 -0
- package/dist/esm/guidance/bundle.js +268 -0
- package/dist/esm/guidance/bundle.js.map +1 -0
- package/dist/esm/guidance/catalog.d.ts +8 -1
- package/dist/esm/guidance/catalog.js +48 -6
- package/dist/esm/guidance/catalog.js.map +1 -1
- package/dist/esm/guidance/index.d.ts +1 -0
- package/dist/esm/guidance/index.js +1 -0
- package/dist/esm/guidance/index.js.map +1 -1
- package/dist/esm/guidance/types.d.ts +17 -1
- package/dist/esm/guidance/types.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/operations/jobs/run-system-job.js +2 -2
- package/dist/esm/operations/jobs/run-system-job.js.map +1 -1
- package/dist/esm/plugins/discovery.js +2 -1
- package/dist/esm/plugins/discovery.js.map +1 -1
- package/dist/esm/scapi/catalog.d.ts +5 -2
- package/dist/esm/scapi/catalog.js.map +1 -1
- package/dist/esm/scapi/index.d.ts +6 -2
- package/dist/esm/scapi/index.js +4 -2
- package/dist/esm/scapi/index.js.map +1 -1
- package/dist/esm/scapi/live.d.ts +14 -3
- package/dist/esm/scapi/live.js +33 -5
- package/dist/esm/scapi/live.js.map +1 -1
- package/dist/esm/scapi/local.d.ts +26 -0
- package/dist/esm/scapi/local.js +143 -0
- package/dist/esm/scapi/local.js.map +1 -0
- package/dist/esm/scapi/request.d.ts +2 -2
- package/dist/esm/scapi/request.js +4 -2
- package/dist/esm/scapi/request.js.map +1 -1
- package/dist/esm/scapi/runtime.d.ts +5 -0
- package/dist/esm/scapi/runtime.js.map +1 -1
- package/dist/esm/scapi/schema-source.d.ts +90 -0
- package/dist/esm/scapi/schema-source.js +146 -0
- package/dist/esm/scapi/schema-source.js.map +1 -0
- package/dist/esm/scapi/worker-source.js +31 -7
- package/dist/esm/scapi/worker-source.js.map +1 -1
- package/dist/esm/telemetry/telemetry.d.ts +1 -0
- package/dist/esm/telemetry/telemetry.js +18 -1
- package/dist/esm/telemetry/telemetry.js.map +1 -1
- package/dist/esm/telemetry/types.d.ts +9 -0
- package/dist/esm/test-utils/config-isolation.js +21 -15
- package/dist/esm/test-utils/config-isolation.js.map +1 -1
- package/dist/esm/ux/agent-context.d.ts +69 -0
- package/dist/esm/ux/agent-context.js +133 -0
- package/dist/esm/ux/agent-context.js.map +1 -0
- package/dist/esm/ux/confirm.d.ts +27 -0
- package/dist/esm/ux/confirm.js +32 -0
- package/dist/esm/ux/confirm.js.map +1 -1
- package/dist/esm/ux/index.d.ts +2 -1
- package/dist/esm/ux/index.js +2 -1
- package/dist/esm/ux/index.js.map +1 -1
- package/node_modules/@salesforce/b2c-api-schemas/manifest.json +83 -42
- package/node_modules/@salesforce/b2c-api-schemas/package.json +1 -1
- package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +6798 -238
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +2296 -205
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +5571 -666
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +6062 -371
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +3426 -360
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +351 -99
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +172 -12
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +1497 -111
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +202 -36
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +79 -10
- package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +785 -49
- package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +191 -40
- package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +1483 -107
- package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +4854 -787
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +119 -15
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +1699 -80
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +252 -18
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +329 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +4208 -234
- package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +1591 -247
- package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +396 -8
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +1242 -69
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +2354 -248
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +1550 -45
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/segmentation/v1.json +6615 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1520 -59
- package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +397 -17
- package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1241 -27
- package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1069 -68
- package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +410 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +502 -102
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1112 -94
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +820 -93
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +845 -92
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +2716 -674
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +130 -47
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +233 -63
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +630 -70
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +2886 -348
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +520 -19
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +3115 -293
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +3313 -138
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +266 -52
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +256 -48
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +1744 -306
- package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1661 -120
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +2174 -118
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1373 -24
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +531 -20
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +154 -6
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +596 -79
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +456 -42
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +101 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +184 -41
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +995 -47
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +370 -67
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +319 -11
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1109 -64
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/deployments/v1.json +1442 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/environments/v1.json +4293 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/storefronts/v1.json +1371 -0
- package/package.json +5 -2
- package/specs/scapi-schemas-v1.yaml +4 -1
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Metrics",
|
|
5
|
-
"
|
|
5
|
+
"description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/metrics/metrics-oas-v1-public.yaml)\n\n# API Overview\n\nThe Metrics API provides programmatic access to time-series operational metrics for Salesforce Commerce Cloud organizations. It exposes the same metrics available in the LogCenter UI, organized by functional category, so that data can be ingested into third-party BI and monitoring tools (such as Tableau or Grafana) and into agentic-observability workflows.\n\nThis is an Admin API: it is intended for operators, SRE teams, and machine clients (BI tools, monitoring agents) acting on behalf of a customer organization, not for storefront shoppers.\n\n> **Note:** The Metrics API is currently in a closed beta. To request access, please contact your account manager.\n\n## Endpoints\n\nThe API exposes nine pre-aggregated metric categories, each accessible through its own typed path:\n\n- **`/metrics/overall`** — Overall application performance metrics\n- **`/metrics/sales`** — Sales and commerce metrics\n- **`/metrics/ecdn`** — eCDN performance and caching metrics\n- **`/metrics/third-party`** — Third-party service integration metrics\n- **`/metrics/scapi`** — SCAPI request and performance metrics\n- **`/metrics/scapi-hooks`** — SCAPI hooks execution metrics\n- **`/metrics/mrt`** — Managed Runtime metrics\n- **`/metrics/controller`** — Controller and pipeline metrics\n- **`/metrics/ocapi`** — OCAPI request and performance metrics\n\nEach request returns a single time-series document for the requested category, organization, and time window.\n\n## Key Features\n\n- **Time-series data retrieval** with Unix epoch time-range parameters (in seconds)\n- **Multiple metric categories** covering all aspects of Commerce Cloud performance\n- **Organization-scoped access** with proper authentication and authorization\n- **Filtering capabilities** for specific APIs, services, and OCAPI sub-categories\n- **Standardized response format** with comprehensive metadata\n\n## Authentication & Authorization\n\nThis API uses standard SCAPI authentication mechanisms:\n\n- **OAuth 2.0** (`AmOAuth2`) with the SCAPI gateway\n- **Organization-scoped access** — callers can only retrieve metrics for organizations they are authorized to access\n\nRequired OAuth scope:\n\n- `sfcc.metrics` — read access to metrics\n\n## Time-Range Constraints\n\nTwo backend-enforced constraints bound every request:\n\n- **Maximum lookback:** `from` must not resolve to a time more than 30 days ago. This matches the configured retention of the underlying metrics store; older data is not retained.\n- **Maximum window:** `to - from` must not exceed 1 day. Requests that exceed this return `400 Bad Request`.\n\n## Use Cases\n\n### Overall application monitoring\nMonitor total platform requests, sessions, and response times.\n\n```\nGET /organizations/{orgId}/metrics/overall?from=1672531200&to=1672534800\n```\n\n### Sales performance tracking\nTrack order creation and basket activity.\n\n```\nGET /organizations/{orgId}/metrics/sales?from=1672488000&to=1672531200\n```\n\n### eCDN performance analysis\nMonitor CDN performance, cache hit rates, and bandwidth usage.\n\n```\nGET /organizations/{orgId}/metrics/ecdn?from=1672509600&to=1672531200\n```\n\n### SCAPI performance monitoring\nMonitor SCAPI request latency and response counts, optionally filtered by API family and / or API name.\n\n```\nGET /organizations/{orgId}/metrics/scapi?from=1672527600&to=1672531200&apiFamily=shopper&apiName=products\n```\n\n### Third-party service monitoring\nTrack third-party service call performance and error rates, optionally filtered to a single named service.\n\n```\nGET /organizations/{orgId}/metrics/third-party?from=1672488000&to=1672531200&thirdPartyServiceId=apple-pay-gateway.apple.com\n```\n\n### SCAPI Hooks performance monitoring\nTrack SCAPI hook execution time and error rates.\n\n```\nGET /organizations/{orgId}/metrics/scapi-hooks?from=1672527600&to=1672531200\n```\n\n### Managed Runtime monitoring\nMonitor MRT request volume, cache hit rates, error rates, and Lambda invocations.\n\n```\nGET /organizations/{orgId}/metrics/mrt?from=1672488000&to=1672531200\n```\n\n### Controller performance monitoring\nTrack controller invocation volume and processing duration.\n\n```\nGET /organizations/{orgId}/metrics/controller?from=1672527600&to=1672531200\n```\n\n### OCAPI performance monitoring\nMonitor OCAPI metrics, optionally filtered by OCAPI category and / or OCAPI API endpoint.\n\n```\nGET /organizations/{orgId}/metrics/ocapi?from=1672527600&to=1672531200&ocapiCategory=shop&ocapiApi=baskets\n```\n\n## Metric Categories\n\n### Overall Application\n- Total Platform Requests — Overall request volume\n- Storefront Requests — Customer-facing request volume\n- Sessions — Active user sessions\n- Response Time — Average response latency\n- Emails Sent — Email delivery volume\n- System Workload — Overall system utilization\n\n### Sales\n- Orders — Order creation rate\n- Basket Creations — Shopping basket creation rate\n- Basket Updates — Basket modification rate\n\n### eCDN\n- Success and Errors — Request success / failure rates\n- Cache Hit Percentage — CDN cache effectiveness\n- Total Requests — Overall CDN request volume\n- Total Bandwidth — Data-transfer volume\n- Total Pageviews — Page view metrics\n- Unique Visitors — Unique visitor tracking\n\n### Third-Party Services\n- Call Counts — API call volume to external services\n- Call Duration p95 — 95th-percentile response times\n- Remote Exceptions — Error rates from external services\n\n### SCAPI\n- Request Latency — API response times\n- Response Count — SCAPI response volume by API family and HTTP status class (2xx/3xx/4xx/5xx)\n- Cache Hit Statistics — API-level caching metrics\n\n### SCAPI Hooks\n- Hook Execution Times — Hook processing duration\n- Hook Errors — Hook execution error rates\n\n### Managed Runtime\n- Request Count — MRT request volume\n- Cache Hit Rates — MRT caching performance\n- Error Rates — MRT error percentages\n- Lambda Invocations — Serverless function executions\n- Request Times — MRT processing duration\n\n### Controller\n- Total Calls — Controller invocation count\n- Average Duration — Controller processing time\n\n### OCAPI\n- Total Calls — OCAPI request volume\n- Average Duration — OCAPI response times\n- Total Errors — OCAPI error counts",
|
|
6
|
+
"version": "1.0.2",
|
|
6
7
|
"x-api-type": "Admin",
|
|
7
8
|
"x-api-family": "Observability"
|
|
8
9
|
},
|
|
@@ -11,6 +12,7 @@
|
|
|
11
12
|
"url": "https://{shortCode}.api.commercecloud.salesforce.com/observability/metrics/v1",
|
|
12
13
|
"variables": {
|
|
13
14
|
"shortCode": {
|
|
15
|
+
"description": "Tenant-specific short code",
|
|
14
16
|
"default": "shortCode"
|
|
15
17
|
}
|
|
16
18
|
}
|
|
@@ -19,39 +21,50 @@
|
|
|
19
21
|
"paths": {
|
|
20
22
|
"/organizations/{organizationId}/metrics/overall": {
|
|
21
23
|
"get": {
|
|
24
|
+
"tags": [
|
|
25
|
+
"Overall Application"
|
|
26
|
+
],
|
|
27
|
+
"summary": "Get Overall Application metrics",
|
|
28
|
+
"description": "Retrieve time series data for all overall application performance metrics including total platform requests, storefront requests, sessions, response time, emails sent, and system workload.",
|
|
22
29
|
"operationId": "getOverallMetrics",
|
|
23
30
|
"parameters": [
|
|
24
31
|
{
|
|
25
32
|
"name": "organizationId",
|
|
26
33
|
"in": "path",
|
|
34
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
27
35
|
"required": true,
|
|
28
36
|
"style": "simple",
|
|
29
37
|
"explode": false,
|
|
30
38
|
"schema": {
|
|
31
39
|
"$ref": "#/components/schemas/OrganizationId"
|
|
32
|
-
}
|
|
40
|
+
},
|
|
41
|
+
"example": "f_ecom_zzxy_prd"
|
|
33
42
|
},
|
|
34
43
|
{
|
|
35
44
|
"name": "from",
|
|
36
45
|
"in": "query",
|
|
46
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
37
47
|
"required": false,
|
|
38
48
|
"style": "form",
|
|
39
49
|
"explode": true,
|
|
40
50
|
"schema": {
|
|
41
51
|
"type": "integer",
|
|
42
52
|
"format": "int64",
|
|
53
|
+
"example": 1672531200,
|
|
43
54
|
"minimum": 1
|
|
44
55
|
}
|
|
45
56
|
},
|
|
46
57
|
{
|
|
47
58
|
"name": "to",
|
|
48
59
|
"in": "query",
|
|
60
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
49
61
|
"required": false,
|
|
50
62
|
"style": "form",
|
|
51
63
|
"explode": true,
|
|
52
64
|
"schema": {
|
|
53
65
|
"type": "integer",
|
|
54
66
|
"format": "int64",
|
|
67
|
+
"example": 1672534800,
|
|
55
68
|
"minimum": 1
|
|
56
69
|
}
|
|
57
70
|
}
|
|
@@ -87,39 +100,50 @@
|
|
|
87
100
|
},
|
|
88
101
|
"/organizations/{organizationId}/metrics/sales": {
|
|
89
102
|
"get": {
|
|
103
|
+
"tags": [
|
|
104
|
+
"Sales"
|
|
105
|
+
],
|
|
106
|
+
"summary": "Get Sales metrics",
|
|
107
|
+
"description": "Retrieve time series data for all sales metrics including orders, basket creations, and basket updates.",
|
|
90
108
|
"operationId": "getSalesMetrics",
|
|
91
109
|
"parameters": [
|
|
92
110
|
{
|
|
93
111
|
"name": "organizationId",
|
|
94
112
|
"in": "path",
|
|
113
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
95
114
|
"required": true,
|
|
96
115
|
"style": "simple",
|
|
97
116
|
"explode": false,
|
|
98
117
|
"schema": {
|
|
99
118
|
"$ref": "#/components/schemas/OrganizationId"
|
|
100
|
-
}
|
|
119
|
+
},
|
|
120
|
+
"example": "f_ecom_zzxy_prd"
|
|
101
121
|
},
|
|
102
122
|
{
|
|
103
123
|
"name": "from",
|
|
104
124
|
"in": "query",
|
|
125
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
105
126
|
"required": false,
|
|
106
127
|
"style": "form",
|
|
107
128
|
"explode": true,
|
|
108
129
|
"schema": {
|
|
109
130
|
"type": "integer",
|
|
110
131
|
"format": "int64",
|
|
132
|
+
"example": 1672531200,
|
|
111
133
|
"minimum": 1
|
|
112
134
|
}
|
|
113
135
|
},
|
|
114
136
|
{
|
|
115
137
|
"name": "to",
|
|
116
138
|
"in": "query",
|
|
139
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
117
140
|
"required": false,
|
|
118
141
|
"style": "form",
|
|
119
142
|
"explode": true,
|
|
120
143
|
"schema": {
|
|
121
144
|
"type": "integer",
|
|
122
145
|
"format": "int64",
|
|
146
|
+
"example": 1672534800,
|
|
123
147
|
"minimum": 1
|
|
124
148
|
}
|
|
125
149
|
}
|
|
@@ -155,39 +179,50 @@
|
|
|
155
179
|
},
|
|
156
180
|
"/organizations/{organizationId}/metrics/ecdn": {
|
|
157
181
|
"get": {
|
|
182
|
+
"tags": [
|
|
183
|
+
"eCDN"
|
|
184
|
+
],
|
|
185
|
+
"summary": "Get eCDN metrics",
|
|
186
|
+
"description": "Retrieve time series data for all eCDN metrics including success and errors, cache hit percentage, total requests, total bandwidth, total pageviews, and unique visitors.",
|
|
158
187
|
"operationId": "getEcdnMetrics",
|
|
159
188
|
"parameters": [
|
|
160
189
|
{
|
|
161
190
|
"name": "organizationId",
|
|
162
191
|
"in": "path",
|
|
192
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
163
193
|
"required": true,
|
|
164
194
|
"style": "simple",
|
|
165
195
|
"explode": false,
|
|
166
196
|
"schema": {
|
|
167
197
|
"$ref": "#/components/schemas/OrganizationId"
|
|
168
|
-
}
|
|
198
|
+
},
|
|
199
|
+
"example": "f_ecom_zzxy_prd"
|
|
169
200
|
},
|
|
170
201
|
{
|
|
171
202
|
"name": "from",
|
|
172
203
|
"in": "query",
|
|
204
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
173
205
|
"required": false,
|
|
174
206
|
"style": "form",
|
|
175
207
|
"explode": true,
|
|
176
208
|
"schema": {
|
|
177
209
|
"type": "integer",
|
|
178
210
|
"format": "int64",
|
|
211
|
+
"example": 1672531200,
|
|
179
212
|
"minimum": 1
|
|
180
213
|
}
|
|
181
214
|
},
|
|
182
215
|
{
|
|
183
216
|
"name": "to",
|
|
184
217
|
"in": "query",
|
|
218
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
185
219
|
"required": false,
|
|
186
220
|
"style": "form",
|
|
187
221
|
"explode": true,
|
|
188
222
|
"schema": {
|
|
189
223
|
"type": "integer",
|
|
190
224
|
"format": "int64",
|
|
225
|
+
"example": 1672534800,
|
|
191
226
|
"minimum": 1
|
|
192
227
|
}
|
|
193
228
|
}
|
|
@@ -223,45 +258,57 @@
|
|
|
223
258
|
},
|
|
224
259
|
"/organizations/{organizationId}/metrics/third-party": {
|
|
225
260
|
"get": {
|
|
261
|
+
"tags": [
|
|
262
|
+
"Third Party Services"
|
|
263
|
+
],
|
|
264
|
+
"summary": "Get Third Party Service metrics",
|
|
265
|
+
"description": "Retrieve time series data for all third party service metrics including call counts, call duration percentiles, and remote exceptions.",
|
|
226
266
|
"operationId": "getThirdPartyMetrics",
|
|
227
267
|
"parameters": [
|
|
228
268
|
{
|
|
229
269
|
"name": "organizationId",
|
|
230
270
|
"in": "path",
|
|
271
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
231
272
|
"required": true,
|
|
232
273
|
"style": "simple",
|
|
233
274
|
"explode": false,
|
|
234
275
|
"schema": {
|
|
235
276
|
"$ref": "#/components/schemas/OrganizationId"
|
|
236
|
-
}
|
|
277
|
+
},
|
|
278
|
+
"example": "f_ecom_zzxy_prd"
|
|
237
279
|
},
|
|
238
280
|
{
|
|
239
281
|
"name": "from",
|
|
240
282
|
"in": "query",
|
|
283
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
241
284
|
"required": false,
|
|
242
285
|
"style": "form",
|
|
243
286
|
"explode": true,
|
|
244
287
|
"schema": {
|
|
245
288
|
"type": "integer",
|
|
246
289
|
"format": "int64",
|
|
290
|
+
"example": 1672531200,
|
|
247
291
|
"minimum": 1
|
|
248
292
|
}
|
|
249
293
|
},
|
|
250
294
|
{
|
|
251
295
|
"name": "to",
|
|
252
296
|
"in": "query",
|
|
297
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
253
298
|
"required": false,
|
|
254
299
|
"style": "form",
|
|
255
300
|
"explode": true,
|
|
256
301
|
"schema": {
|
|
257
302
|
"type": "integer",
|
|
258
303
|
"format": "int64",
|
|
304
|
+
"example": 1672534800,
|
|
259
305
|
"minimum": 1
|
|
260
306
|
}
|
|
261
307
|
},
|
|
262
308
|
{
|
|
263
309
|
"name": "thirdPartyServiceId",
|
|
264
310
|
"in": "query",
|
|
311
|
+
"description": "Filter by a specific third party service identifier (typically a hostname,\ne.g. `apple-pay-gateway.apple.com`). The list of services is customer-configured;\nomit this parameter to get one data series per (realm, third party service).\n",
|
|
265
312
|
"required": false,
|
|
266
313
|
"style": "form",
|
|
267
314
|
"explode": true,
|
|
@@ -301,50 +348,63 @@
|
|
|
301
348
|
},
|
|
302
349
|
"/organizations/{organizationId}/metrics/scapi": {
|
|
303
350
|
"get": {
|
|
351
|
+
"tags": [
|
|
352
|
+
"SCAPI"
|
|
353
|
+
],
|
|
354
|
+
"summary": "Get SCAPI metrics",
|
|
355
|
+
"description": "Retrieve time series data for all SCAPI metrics including request latency, response counts, and cache hit statistics.",
|
|
304
356
|
"operationId": "getScapiMetrics",
|
|
305
357
|
"parameters": [
|
|
306
358
|
{
|
|
307
359
|
"name": "organizationId",
|
|
308
360
|
"in": "path",
|
|
361
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
309
362
|
"required": true,
|
|
310
363
|
"style": "simple",
|
|
311
364
|
"explode": false,
|
|
312
365
|
"schema": {
|
|
313
366
|
"$ref": "#/components/schemas/OrganizationId"
|
|
314
|
-
}
|
|
367
|
+
},
|
|
368
|
+
"example": "f_ecom_zzxy_prd"
|
|
315
369
|
},
|
|
316
370
|
{
|
|
317
371
|
"name": "from",
|
|
318
372
|
"in": "query",
|
|
373
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
319
374
|
"required": false,
|
|
320
375
|
"style": "form",
|
|
321
376
|
"explode": true,
|
|
322
377
|
"schema": {
|
|
323
378
|
"type": "integer",
|
|
324
379
|
"format": "int64",
|
|
380
|
+
"example": 1672531200,
|
|
325
381
|
"minimum": 1
|
|
326
382
|
}
|
|
327
383
|
},
|
|
328
384
|
{
|
|
329
385
|
"name": "to",
|
|
330
386
|
"in": "query",
|
|
387
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
331
388
|
"required": false,
|
|
332
389
|
"style": "form",
|
|
333
390
|
"explode": true,
|
|
334
391
|
"schema": {
|
|
335
392
|
"type": "integer",
|
|
336
393
|
"format": "int64",
|
|
394
|
+
"example": 1672534800,
|
|
337
395
|
"minimum": 1
|
|
338
396
|
}
|
|
339
397
|
},
|
|
340
398
|
{
|
|
341
399
|
"name": "apiFamily",
|
|
342
400
|
"in": "query",
|
|
401
|
+
"description": "Filter by SCAPI family name",
|
|
343
402
|
"required": false,
|
|
344
403
|
"style": "form",
|
|
345
404
|
"explode": true,
|
|
346
405
|
"schema": {
|
|
347
406
|
"type": "string",
|
|
407
|
+
"example": "shopper",
|
|
348
408
|
"maxLength": 100,
|
|
349
409
|
"minLength": 1
|
|
350
410
|
}
|
|
@@ -352,11 +412,13 @@
|
|
|
352
412
|
{
|
|
353
413
|
"name": "apiName",
|
|
354
414
|
"in": "query",
|
|
415
|
+
"description": "Filter by specific SCAPI name",
|
|
355
416
|
"required": false,
|
|
356
417
|
"style": "form",
|
|
357
418
|
"explode": true,
|
|
358
419
|
"schema": {
|
|
359
420
|
"type": "string",
|
|
421
|
+
"example": "products",
|
|
360
422
|
"maxLength": 100,
|
|
361
423
|
"minLength": 1
|
|
362
424
|
}
|
|
@@ -393,39 +455,50 @@
|
|
|
393
455
|
},
|
|
394
456
|
"/organizations/{organizationId}/metrics/scapi-hooks": {
|
|
395
457
|
"get": {
|
|
458
|
+
"tags": [
|
|
459
|
+
"SCAPI Hooks"
|
|
460
|
+
],
|
|
461
|
+
"summary": "Get SCAPI Hooks metrics",
|
|
462
|
+
"description": "Retrieve time series data for all SCAPI hooks metrics including hook execution times and hook errors.",
|
|
396
463
|
"operationId": "getScapiHooksMetrics",
|
|
397
464
|
"parameters": [
|
|
398
465
|
{
|
|
399
466
|
"name": "organizationId",
|
|
400
467
|
"in": "path",
|
|
468
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
401
469
|
"required": true,
|
|
402
470
|
"style": "simple",
|
|
403
471
|
"explode": false,
|
|
404
472
|
"schema": {
|
|
405
473
|
"$ref": "#/components/schemas/OrganizationId"
|
|
406
|
-
}
|
|
474
|
+
},
|
|
475
|
+
"example": "f_ecom_zzxy_prd"
|
|
407
476
|
},
|
|
408
477
|
{
|
|
409
478
|
"name": "from",
|
|
410
479
|
"in": "query",
|
|
480
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
411
481
|
"required": false,
|
|
412
482
|
"style": "form",
|
|
413
483
|
"explode": true,
|
|
414
484
|
"schema": {
|
|
415
485
|
"type": "integer",
|
|
416
486
|
"format": "int64",
|
|
487
|
+
"example": 1672531200,
|
|
417
488
|
"minimum": 1
|
|
418
489
|
}
|
|
419
490
|
},
|
|
420
491
|
{
|
|
421
492
|
"name": "to",
|
|
422
493
|
"in": "query",
|
|
494
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
423
495
|
"required": false,
|
|
424
496
|
"style": "form",
|
|
425
497
|
"explode": true,
|
|
426
498
|
"schema": {
|
|
427
499
|
"type": "integer",
|
|
428
500
|
"format": "int64",
|
|
501
|
+
"example": 1672534800,
|
|
429
502
|
"minimum": 1
|
|
430
503
|
}
|
|
431
504
|
}
|
|
@@ -461,39 +534,50 @@
|
|
|
461
534
|
},
|
|
462
535
|
"/organizations/{organizationId}/metrics/mrt": {
|
|
463
536
|
"get": {
|
|
537
|
+
"tags": [
|
|
538
|
+
"Managed Runtime"
|
|
539
|
+
],
|
|
540
|
+
"summary": "Get Managed Runtime metrics",
|
|
541
|
+
"description": "Retrieve time series data for all Managed Runtime metrics including request counts, cache hit rates, error rates, Lambda invocations, and request times.",
|
|
464
542
|
"operationId": "getMrtMetrics",
|
|
465
543
|
"parameters": [
|
|
466
544
|
{
|
|
467
545
|
"name": "organizationId",
|
|
468
546
|
"in": "path",
|
|
547
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
469
548
|
"required": true,
|
|
470
549
|
"style": "simple",
|
|
471
550
|
"explode": false,
|
|
472
551
|
"schema": {
|
|
473
552
|
"$ref": "#/components/schemas/OrganizationId"
|
|
474
|
-
}
|
|
553
|
+
},
|
|
554
|
+
"example": "f_ecom_zzxy_prd"
|
|
475
555
|
},
|
|
476
556
|
{
|
|
477
557
|
"name": "from",
|
|
478
558
|
"in": "query",
|
|
559
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
479
560
|
"required": false,
|
|
480
561
|
"style": "form",
|
|
481
562
|
"explode": true,
|
|
482
563
|
"schema": {
|
|
483
564
|
"type": "integer",
|
|
484
565
|
"format": "int64",
|
|
566
|
+
"example": 1672531200,
|
|
485
567
|
"minimum": 1
|
|
486
568
|
}
|
|
487
569
|
},
|
|
488
570
|
{
|
|
489
571
|
"name": "to",
|
|
490
572
|
"in": "query",
|
|
573
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
491
574
|
"required": false,
|
|
492
575
|
"style": "form",
|
|
493
576
|
"explode": true,
|
|
494
577
|
"schema": {
|
|
495
578
|
"type": "integer",
|
|
496
579
|
"format": "int64",
|
|
580
|
+
"example": 1672534800,
|
|
497
581
|
"minimum": 1
|
|
498
582
|
}
|
|
499
583
|
}
|
|
@@ -529,39 +613,50 @@
|
|
|
529
613
|
},
|
|
530
614
|
"/organizations/{organizationId}/metrics/controller": {
|
|
531
615
|
"get": {
|
|
616
|
+
"tags": [
|
|
617
|
+
"Controller"
|
|
618
|
+
],
|
|
619
|
+
"summary": "Get Controller metrics",
|
|
620
|
+
"description": "Retrieve time series data for all controller/pipeline metrics including total calls and average duration.",
|
|
532
621
|
"operationId": "getControllerMetrics",
|
|
533
622
|
"parameters": [
|
|
534
623
|
{
|
|
535
624
|
"name": "organizationId",
|
|
536
625
|
"in": "path",
|
|
626
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
537
627
|
"required": true,
|
|
538
628
|
"style": "simple",
|
|
539
629
|
"explode": false,
|
|
540
630
|
"schema": {
|
|
541
631
|
"$ref": "#/components/schemas/OrganizationId"
|
|
542
|
-
}
|
|
632
|
+
},
|
|
633
|
+
"example": "f_ecom_zzxy_prd"
|
|
543
634
|
},
|
|
544
635
|
{
|
|
545
636
|
"name": "from",
|
|
546
637
|
"in": "query",
|
|
638
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
547
639
|
"required": false,
|
|
548
640
|
"style": "form",
|
|
549
641
|
"explode": true,
|
|
550
642
|
"schema": {
|
|
551
643
|
"type": "integer",
|
|
552
644
|
"format": "int64",
|
|
645
|
+
"example": 1672531200,
|
|
553
646
|
"minimum": 1
|
|
554
647
|
}
|
|
555
648
|
},
|
|
556
649
|
{
|
|
557
650
|
"name": "to",
|
|
558
651
|
"in": "query",
|
|
652
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
559
653
|
"required": false,
|
|
560
654
|
"style": "form",
|
|
561
655
|
"explode": true,
|
|
562
656
|
"schema": {
|
|
563
657
|
"type": "integer",
|
|
564
658
|
"format": "int64",
|
|
659
|
+
"example": 1672534800,
|
|
565
660
|
"minimum": 1
|
|
566
661
|
}
|
|
567
662
|
}
|
|
@@ -597,50 +692,63 @@
|
|
|
597
692
|
},
|
|
598
693
|
"/organizations/{organizationId}/metrics/ocapi": {
|
|
599
694
|
"get": {
|
|
695
|
+
"tags": [
|
|
696
|
+
"OCAPI"
|
|
697
|
+
],
|
|
698
|
+
"summary": "Get OCAPI metrics",
|
|
699
|
+
"description": "Retrieve time series data for all Open Commerce API metrics including total calls, average duration, and total errors.",
|
|
600
700
|
"operationId": "getOcapiMetrics",
|
|
601
701
|
"parameters": [
|
|
602
702
|
{
|
|
603
703
|
"name": "organizationId",
|
|
604
704
|
"in": "path",
|
|
705
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
605
706
|
"required": true,
|
|
606
707
|
"style": "simple",
|
|
607
708
|
"explode": false,
|
|
608
709
|
"schema": {
|
|
609
710
|
"$ref": "#/components/schemas/OrganizationId"
|
|
610
|
-
}
|
|
711
|
+
},
|
|
712
|
+
"example": "f_ecom_zzxy_prd"
|
|
611
713
|
},
|
|
612
714
|
{
|
|
613
715
|
"name": "from",
|
|
614
716
|
"in": "query",
|
|
717
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
615
718
|
"required": false,
|
|
616
719
|
"style": "form",
|
|
617
720
|
"explode": true,
|
|
618
721
|
"schema": {
|
|
619
722
|
"type": "integer",
|
|
620
723
|
"format": "int64",
|
|
724
|
+
"example": 1672531200,
|
|
621
725
|
"minimum": 1
|
|
622
726
|
}
|
|
623
727
|
},
|
|
624
728
|
{
|
|
625
729
|
"name": "to",
|
|
626
730
|
"in": "query",
|
|
731
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
627
732
|
"required": false,
|
|
628
733
|
"style": "form",
|
|
629
734
|
"explode": true,
|
|
630
735
|
"schema": {
|
|
631
736
|
"type": "integer",
|
|
632
737
|
"format": "int64",
|
|
738
|
+
"example": 1672534800,
|
|
633
739
|
"minimum": 1
|
|
634
740
|
}
|
|
635
741
|
},
|
|
636
742
|
{
|
|
637
743
|
"name": "ocapiCategory",
|
|
638
744
|
"in": "query",
|
|
745
|
+
"description": "Filter by Open Commerce API category. Common values include `shop`, `data` and `mercury`.\nQueries with values that don't match any series return 200 with empty data.\n",
|
|
639
746
|
"required": false,
|
|
640
747
|
"style": "form",
|
|
641
748
|
"explode": true,
|
|
642
749
|
"schema": {
|
|
643
750
|
"type": "string",
|
|
751
|
+
"example": "shop",
|
|
644
752
|
"maxLength": 100,
|
|
645
753
|
"minLength": 1
|
|
646
754
|
}
|
|
@@ -648,11 +756,13 @@
|
|
|
648
756
|
{
|
|
649
757
|
"name": "ocapiApi",
|
|
650
758
|
"in": "query",
|
|
759
|
+
"description": "Filter by specific Open Commerce API endpoint (e.g. `baskets`).",
|
|
651
760
|
"required": false,
|
|
652
761
|
"style": "form",
|
|
653
762
|
"explode": true,
|
|
654
763
|
"schema": {
|
|
655
764
|
"type": "string",
|
|
765
|
+
"example": "baskets",
|
|
656
766
|
"maxLength": 100,
|
|
657
767
|
"minLength": 1
|
|
658
768
|
}
|
|
@@ -692,28 +802,39 @@
|
|
|
692
802
|
"schemas": {
|
|
693
803
|
"OrganizationId": {
|
|
694
804
|
"type": "string",
|
|
805
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
806
|
+
"example": "f_ecom_zzxy_prd",
|
|
695
807
|
"pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
|
|
696
808
|
},
|
|
697
809
|
"MetricId": {
|
|
698
810
|
"type": "string",
|
|
811
|
+
"description": "Unique identifier for a metric type",
|
|
812
|
+
"example": "totalCalls",
|
|
699
813
|
"maxLength": 100,
|
|
700
814
|
"minLength": 1,
|
|
701
815
|
"pattern": "^[a-zA-Z0-9_-]+$"
|
|
702
816
|
},
|
|
703
817
|
"DataSeriesId": {
|
|
704
818
|
"type": "string",
|
|
819
|
+
"description": "Unique identifier for a data series within a metric",
|
|
820
|
+
"example": "realm1.totalCalls",
|
|
705
821
|
"maxLength": 200,
|
|
706
822
|
"minLength": 1
|
|
707
823
|
},
|
|
708
824
|
"DataPoint": {
|
|
709
825
|
"type": "object",
|
|
826
|
+
"description": "A single time series data point",
|
|
710
827
|
"properties": {
|
|
711
828
|
"timestamp": {
|
|
712
829
|
"type": "integer",
|
|
830
|
+
"description": "Unix timestamp of the data point",
|
|
831
|
+
"example": 1640995200,
|
|
713
832
|
"minimum": 0
|
|
714
833
|
},
|
|
715
834
|
"value": {
|
|
716
|
-
"type": "number"
|
|
835
|
+
"type": "number",
|
|
836
|
+
"description": "Metric value at the timestamp",
|
|
837
|
+
"example": 1250.5
|
|
717
838
|
}
|
|
718
839
|
},
|
|
719
840
|
"required": [
|
|
@@ -723,17 +844,21 @@
|
|
|
723
844
|
},
|
|
724
845
|
"DataSeries": {
|
|
725
846
|
"type": "object",
|
|
847
|
+
"description": "Time series data for a specific realm/filter combination",
|
|
726
848
|
"properties": {
|
|
727
849
|
"id": {
|
|
728
850
|
"$ref": "#/components/schemas/DataSeriesId"
|
|
729
851
|
},
|
|
730
852
|
"name": {
|
|
731
853
|
"type": "string",
|
|
854
|
+
"description": "Human-readable name of the data series",
|
|
855
|
+
"example": "realm1 Total Calls",
|
|
732
856
|
"maxLength": 200,
|
|
733
857
|
"minLength": 1
|
|
734
858
|
},
|
|
735
859
|
"data": {
|
|
736
860
|
"type": "array",
|
|
861
|
+
"description": "Array of time series data points",
|
|
737
862
|
"items": {
|
|
738
863
|
"$ref": "#/components/schemas/DataPoint"
|
|
739
864
|
}
|
|
@@ -747,27 +872,35 @@
|
|
|
747
872
|
},
|
|
748
873
|
"Metric": {
|
|
749
874
|
"type": "object",
|
|
875
|
+
"description": "A single metric with its metadata and time series data",
|
|
750
876
|
"properties": {
|
|
751
877
|
"metricId": {
|
|
752
878
|
"$ref": "#/components/schemas/MetricId"
|
|
753
879
|
},
|
|
754
880
|
"title": {
|
|
755
881
|
"type": "string",
|
|
882
|
+
"description": "Human-readable title of the metric",
|
|
883
|
+
"example": "Total Platform Requests",
|
|
756
884
|
"maxLength": 200,
|
|
757
885
|
"minLength": 1
|
|
758
886
|
},
|
|
759
887
|
"description": {
|
|
760
888
|
"type": "string",
|
|
889
|
+
"description": "Description of what this metric measures",
|
|
890
|
+
"example": "Total number of platform requests per minute.",
|
|
761
891
|
"maxLength": 500,
|
|
762
892
|
"minLength": 1
|
|
763
893
|
},
|
|
764
894
|
"unit": {
|
|
765
895
|
"type": "string",
|
|
896
|
+
"description": "Unit of measurement for the metric values. Optional: omitted (or empty) when the unit is implied by the metric title (e.g. \"Number of Calls\", \"Storefront Requests\" — count metrics).\n",
|
|
897
|
+
"example": "requests/min",
|
|
766
898
|
"maxLength": 50,
|
|
767
899
|
"minLength": 0
|
|
768
900
|
},
|
|
769
901
|
"dataSeries": {
|
|
770
902
|
"type": "array",
|
|
903
|
+
"description": "Data series for this metric across different realms/filters",
|
|
771
904
|
"items": {
|
|
772
905
|
"$ref": "#/components/schemas/DataSeries"
|
|
773
906
|
}
|
|
@@ -783,9 +916,33 @@
|
|
|
783
916
|
"MetricsDataResponse": {
|
|
784
917
|
"type": "object",
|
|
785
918
|
"additionalProperties": false,
|
|
919
|
+
"description": "Response containing metrics data for a requested category",
|
|
920
|
+
"example": {
|
|
921
|
+
"data": [
|
|
922
|
+
{
|
|
923
|
+
"metricId": "totalCalls",
|
|
924
|
+
"title": "Total Platform Requests",
|
|
925
|
+
"description": "Total number of platform requests per minute.",
|
|
926
|
+
"unit": "requests/min",
|
|
927
|
+
"dataSeries": [
|
|
928
|
+
{
|
|
929
|
+
"id": "realm1.totalCalls",
|
|
930
|
+
"name": "realm1 Total Calls",
|
|
931
|
+
"data": [
|
|
932
|
+
{
|
|
933
|
+
"timestamp": 1640995200,
|
|
934
|
+
"value": 1250.5
|
|
935
|
+
}
|
|
936
|
+
]
|
|
937
|
+
}
|
|
938
|
+
]
|
|
939
|
+
}
|
|
940
|
+
]
|
|
941
|
+
},
|
|
786
942
|
"properties": {
|
|
787
943
|
"data": {
|
|
788
944
|
"type": "array",
|
|
945
|
+
"description": "Array of metrics for the requested category",
|
|
789
946
|
"items": {
|
|
790
947
|
"$ref": "#/components/schemas/Metric"
|
|
791
948
|
}
|
|
@@ -801,17 +958,25 @@
|
|
|
801
958
|
"properties": {
|
|
802
959
|
"title": {
|
|
803
960
|
"type": "string",
|
|
961
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the \nproblem, except for purposes of localization\n",
|
|
962
|
+
"example": "You do not have enough credit",
|
|
804
963
|
"maxLength": 256
|
|
805
964
|
},
|
|
806
965
|
"type": {
|
|
807
966
|
"type": "string",
|
|
967
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
968
|
+
"example": "NotEnoughMoney",
|
|
808
969
|
"maxLength": 2048
|
|
809
970
|
},
|
|
810
971
|
"detail": {
|
|
811
|
-
"type": "string"
|
|
972
|
+
"type": "string",
|
|
973
|
+
"description": "A human-readable explanation specific to this occurrence of the problem.",
|
|
974
|
+
"example": "Your current balance is 30, but that costs 50"
|
|
812
975
|
},
|
|
813
976
|
"instance": {
|
|
814
977
|
"type": "string",
|
|
978
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
979
|
+
"example": "/account/12345/msgs/abc",
|
|
815
980
|
"maxLength": 2048
|
|
816
981
|
}
|
|
817
982
|
},
|
|
@@ -827,9 +992,12 @@
|
|
|
827
992
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
828
993
|
}
|
|
829
994
|
],
|
|
995
|
+
"description": "Returned when an invalid time parameter format is provided",
|
|
830
996
|
"properties": {
|
|
831
997
|
"parameter": {
|
|
832
998
|
"type": "string",
|
|
999
|
+
"description": "The invalid parameter name that caused the error",
|
|
1000
|
+
"example": "from",
|
|
833
1001
|
"maxLength": 100
|
|
834
1002
|
}
|
|
835
1003
|
},
|
|
@@ -843,14 +1011,19 @@
|
|
|
843
1011
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
844
1012
|
}
|
|
845
1013
|
],
|
|
1014
|
+
"description": "Returned when the from parameter is later than the to parameter",
|
|
846
1015
|
"properties": {
|
|
847
1016
|
"fromValue": {
|
|
848
1017
|
"type": "integer",
|
|
849
|
-
"format": "int64"
|
|
1018
|
+
"format": "int64",
|
|
1019
|
+
"description": "The from parameter value that caused the error",
|
|
1020
|
+
"example": 1672534800
|
|
850
1021
|
},
|
|
851
1022
|
"toValue": {
|
|
852
1023
|
"type": "integer",
|
|
853
|
-
"format": "int64"
|
|
1024
|
+
"format": "int64",
|
|
1025
|
+
"description": "The to parameter value that caused the error",
|
|
1026
|
+
"example": 1672531200
|
|
854
1027
|
}
|
|
855
1028
|
},
|
|
856
1029
|
"required": [
|
|
@@ -864,9 +1037,12 @@
|
|
|
864
1037
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
865
1038
|
}
|
|
866
1039
|
],
|
|
1040
|
+
"description": "Returned when a metrics category is not found or not available",
|
|
867
1041
|
"properties": {
|
|
868
1042
|
"category": {
|
|
869
1043
|
"type": "string",
|
|
1044
|
+
"description": "The requested category that was not found",
|
|
1045
|
+
"example": "unknown-category",
|
|
870
1046
|
"maxLength": 50
|
|
871
1047
|
},
|
|
872
1048
|
"organizationId": {
|
|
@@ -880,6 +1056,7 @@
|
|
|
880
1056
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
881
1057
|
}
|
|
882
1058
|
],
|
|
1059
|
+
"description": "Returned when metrics data is temporarily unavailable",
|
|
883
1060
|
"properties": {
|
|
884
1061
|
"organizationId": {
|
|
885
1062
|
"$ref": "#/components/schemas/OrganizationId"
|
|
@@ -888,6 +1065,8 @@
|
|
|
888
1065
|
},
|
|
889
1066
|
"ThirdPartyServiceId": {
|
|
890
1067
|
"type": "string",
|
|
1068
|
+
"description": "Third party service identifier, typically a hostname (e.g. `apple-pay-gateway.apple.com`).\nThe list of services is customer-configured.\n",
|
|
1069
|
+
"example": "apple-pay-gateway.apple.com",
|
|
891
1070
|
"maxLength": 255,
|
|
892
1071
|
"minLength": 1
|
|
893
1072
|
},
|
|
@@ -897,6 +1076,7 @@
|
|
|
897
1076
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
898
1077
|
}
|
|
899
1078
|
],
|
|
1079
|
+
"description": "Returned when an invalid third party service filter is provided",
|
|
900
1080
|
"properties": {
|
|
901
1081
|
"thirdPartyServiceId": {
|
|
902
1082
|
"$ref": "#/components/schemas/ThirdPartyServiceId"
|
|
@@ -916,13 +1096,18 @@
|
|
|
916
1096
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
917
1097
|
}
|
|
918
1098
|
],
|
|
1099
|
+
"description": "Returned when an invalid SCAPI or OCAPI filter value is provided (apiFamily, apiName, ocapiApi)",
|
|
919
1100
|
"properties": {
|
|
920
1101
|
"filterName": {
|
|
921
1102
|
"type": "string",
|
|
1103
|
+
"description": "The filter parameter name that received an invalid value",
|
|
1104
|
+
"example": "apiFamily",
|
|
922
1105
|
"maxLength": 100
|
|
923
1106
|
},
|
|
924
1107
|
"filterValue": {
|
|
925
1108
|
"type": "string",
|
|
1109
|
+
"description": "The invalid value provided for the filter",
|
|
1110
|
+
"example": "invalid-family",
|
|
926
1111
|
"maxLength": 100
|
|
927
1112
|
}
|
|
928
1113
|
},
|
|
@@ -939,6 +1124,11 @@
|
|
|
939
1124
|
"application/json": {
|
|
940
1125
|
"schema": {
|
|
941
1126
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1127
|
+
},
|
|
1128
|
+
"examples": {
|
|
1129
|
+
"OverallMetricsResponseExample": {
|
|
1130
|
+
"$ref": "#/components/examples/OverallMetricsResponseExample"
|
|
1131
|
+
}
|
|
942
1132
|
}
|
|
943
1133
|
}
|
|
944
1134
|
}
|
|
@@ -956,6 +1146,31 @@
|
|
|
956
1146
|
"$ref": "#/components/schemas/InvalidTimeRangeErrorResponse"
|
|
957
1147
|
}
|
|
958
1148
|
]
|
|
1149
|
+
},
|
|
1150
|
+
"examples": {
|
|
1151
|
+
"InvalidTimeParameterExample": {
|
|
1152
|
+
"value": {
|
|
1153
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1154
|
+
"title": "Bad Request",
|
|
1155
|
+
"detail": "Invalid time parameter 'from'. Must be a Unix epoch timestamp in seconds (e.g., 1672531200).",
|
|
1156
|
+
"parameter": "from"
|
|
1157
|
+
}
|
|
1158
|
+
},
|
|
1159
|
+
"InvalidTimeRangeExample": {
|
|
1160
|
+
"value": {
|
|
1161
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1162
|
+
"title": "Bad Request",
|
|
1163
|
+
"detail": "Invalid time range: 'from' (1672534800) must be earlier than 'to' (1672531200).",
|
|
1164
|
+
"fromValue": 1672534800,
|
|
1165
|
+
"toValue": 1672531200
|
|
1166
|
+
}
|
|
1167
|
+
},
|
|
1168
|
+
"InvalidTimeParameterErrorResponseExample": {
|
|
1169
|
+
"$ref": "#/components/examples/InvalidTimeParameterErrorResponseExample"
|
|
1170
|
+
},
|
|
1171
|
+
"InvalidTimeRangeErrorResponseExample": {
|
|
1172
|
+
"$ref": "#/components/examples/InvalidTimeRangeErrorResponseExample"
|
|
1173
|
+
}
|
|
959
1174
|
}
|
|
960
1175
|
}
|
|
961
1176
|
}
|
|
@@ -966,6 +1181,11 @@
|
|
|
966
1181
|
"application/problem+json": {
|
|
967
1182
|
"schema": {
|
|
968
1183
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1184
|
+
},
|
|
1185
|
+
"examples": {
|
|
1186
|
+
"UnauthorizedExample": {
|
|
1187
|
+
"$ref": "#/components/examples/UnauthorizedExample"
|
|
1188
|
+
}
|
|
969
1189
|
}
|
|
970
1190
|
}
|
|
971
1191
|
}
|
|
@@ -976,6 +1196,11 @@
|
|
|
976
1196
|
"application/problem+json": {
|
|
977
1197
|
"schema": {
|
|
978
1198
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
1199
|
+
},
|
|
1200
|
+
"examples": {
|
|
1201
|
+
"ForbiddenExample": {
|
|
1202
|
+
"$ref": "#/components/examples/ForbiddenExample"
|
|
1203
|
+
}
|
|
979
1204
|
}
|
|
980
1205
|
}
|
|
981
1206
|
}
|
|
@@ -986,6 +1211,20 @@
|
|
|
986
1211
|
"application/problem+json": {
|
|
987
1212
|
"schema": {
|
|
988
1213
|
"$ref": "#/components/schemas/CategoryNotFoundErrorResponse"
|
|
1214
|
+
},
|
|
1215
|
+
"examples": {
|
|
1216
|
+
"CategoryNotFoundExample": {
|
|
1217
|
+
"value": {
|
|
1218
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/not-found",
|
|
1219
|
+
"title": "Not Found",
|
|
1220
|
+
"detail": "Metrics category 'unknown-category' not found or not available for organization 'f_ecom_zzxy_prd'.",
|
|
1221
|
+
"category": "unknown-category",
|
|
1222
|
+
"organizationId": "f_ecom_zzxy_prd"
|
|
1223
|
+
}
|
|
1224
|
+
},
|
|
1225
|
+
"CategoryNotFoundErrorResponseExample": {
|
|
1226
|
+
"$ref": "#/components/examples/CategoryNotFoundErrorResponseExample"
|
|
1227
|
+
}
|
|
989
1228
|
}
|
|
990
1229
|
}
|
|
991
1230
|
}
|
|
@@ -996,6 +1235,19 @@
|
|
|
996
1235
|
"application/problem+json": {
|
|
997
1236
|
"schema": {
|
|
998
1237
|
"$ref": "#/components/schemas/MetricsNotAvailableErrorResponse"
|
|
1238
|
+
},
|
|
1239
|
+
"examples": {
|
|
1240
|
+
"MetricsUnavailableExample": {
|
|
1241
|
+
"value": {
|
|
1242
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/service-unavailable",
|
|
1243
|
+
"title": "Service Unavailable",
|
|
1244
|
+
"detail": "Metrics data is temporarily unavailable for organization 'f_ecom_zzxy_prd'. Please try again later.",
|
|
1245
|
+
"organizationId": "f_ecom_zzxy_prd"
|
|
1246
|
+
}
|
|
1247
|
+
},
|
|
1248
|
+
"MetricsNotAvailableErrorResponseExample": {
|
|
1249
|
+
"$ref": "#/components/examples/MetricsNotAvailableErrorResponseExample"
|
|
1250
|
+
}
|
|
999
1251
|
}
|
|
1000
1252
|
}
|
|
1001
1253
|
}
|
|
@@ -1006,6 +1258,11 @@
|
|
|
1006
1258
|
"application/json": {
|
|
1007
1259
|
"schema": {
|
|
1008
1260
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1261
|
+
},
|
|
1262
|
+
"examples": {
|
|
1263
|
+
"SalesMetricsResponseExample": {
|
|
1264
|
+
"$ref": "#/components/examples/SalesMetricsResponseExample"
|
|
1265
|
+
}
|
|
1009
1266
|
}
|
|
1010
1267
|
}
|
|
1011
1268
|
}
|
|
@@ -1016,6 +1273,11 @@
|
|
|
1016
1273
|
"application/json": {
|
|
1017
1274
|
"schema": {
|
|
1018
1275
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1276
|
+
},
|
|
1277
|
+
"examples": {
|
|
1278
|
+
"EcdnMetricsResponseExample": {
|
|
1279
|
+
"$ref": "#/components/examples/EcdnMetricsResponseExample"
|
|
1280
|
+
}
|
|
1019
1281
|
}
|
|
1020
1282
|
}
|
|
1021
1283
|
}
|
|
@@ -1026,6 +1288,11 @@
|
|
|
1026
1288
|
"application/json": {
|
|
1027
1289
|
"schema": {
|
|
1028
1290
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1291
|
+
},
|
|
1292
|
+
"examples": {
|
|
1293
|
+
"ThirdPartyMetricsResponseExample": {
|
|
1294
|
+
"$ref": "#/components/examples/ThirdPartyMetricsResponseExample"
|
|
1295
|
+
}
|
|
1029
1296
|
}
|
|
1030
1297
|
}
|
|
1031
1298
|
}
|
|
@@ -1046,6 +1313,43 @@
|
|
|
1046
1313
|
"$ref": "#/components/schemas/InvalidThirdPartyServiceErrorResponse"
|
|
1047
1314
|
}
|
|
1048
1315
|
]
|
|
1316
|
+
},
|
|
1317
|
+
"examples": {
|
|
1318
|
+
"InvalidTimeParameterExample": {
|
|
1319
|
+
"value": {
|
|
1320
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1321
|
+
"title": "Bad Request",
|
|
1322
|
+
"detail": "Invalid time parameter 'from'. Must be a Unix epoch timestamp in seconds (e.g., 1672531200).",
|
|
1323
|
+
"parameter": "from"
|
|
1324
|
+
}
|
|
1325
|
+
},
|
|
1326
|
+
"InvalidTimeRangeExample": {
|
|
1327
|
+
"value": {
|
|
1328
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1329
|
+
"title": "Bad Request",
|
|
1330
|
+
"detail": "Invalid time range: 'from' (1672534800) must be earlier than 'to' (1672531200).",
|
|
1331
|
+
"fromValue": 1672534800,
|
|
1332
|
+
"toValue": 1672531200
|
|
1333
|
+
}
|
|
1334
|
+
},
|
|
1335
|
+
"InvalidThirdPartyServiceExample": {
|
|
1336
|
+
"value": {
|
|
1337
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1338
|
+
"title": "Bad Request",
|
|
1339
|
+
"detail": "Third party service 'unknown-service.example.com' not found for organization 'f_ecom_zzxy_prd'.",
|
|
1340
|
+
"thirdPartyServiceId": "unknown-service.example.com",
|
|
1341
|
+
"organizationId": "f_ecom_zzxy_prd"
|
|
1342
|
+
}
|
|
1343
|
+
},
|
|
1344
|
+
"InvalidTimeParameterErrorResponseExample": {
|
|
1345
|
+
"$ref": "#/components/examples/InvalidTimeParameterErrorResponseExample"
|
|
1346
|
+
},
|
|
1347
|
+
"InvalidTimeRangeErrorResponseExample": {
|
|
1348
|
+
"$ref": "#/components/examples/InvalidTimeRangeErrorResponseExample"
|
|
1349
|
+
},
|
|
1350
|
+
"InvalidThirdPartyServiceErrorResponseExample": {
|
|
1351
|
+
"$ref": "#/components/examples/InvalidThirdPartyServiceErrorResponseExample"
|
|
1352
|
+
}
|
|
1049
1353
|
}
|
|
1050
1354
|
}
|
|
1051
1355
|
}
|
|
@@ -1056,6 +1360,11 @@
|
|
|
1056
1360
|
"application/json": {
|
|
1057
1361
|
"schema": {
|
|
1058
1362
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1363
|
+
},
|
|
1364
|
+
"examples": {
|
|
1365
|
+
"ScapiMetricsResponseExample": {
|
|
1366
|
+
"$ref": "#/components/examples/ScapiMetricsResponseExample"
|
|
1367
|
+
}
|
|
1059
1368
|
}
|
|
1060
1369
|
}
|
|
1061
1370
|
}
|
|
@@ -1076,6 +1385,52 @@
|
|
|
1076
1385
|
"$ref": "#/components/schemas/InvalidApiFilterErrorResponse"
|
|
1077
1386
|
}
|
|
1078
1387
|
]
|
|
1388
|
+
},
|
|
1389
|
+
"examples": {
|
|
1390
|
+
"InvalidTimeParameterExample": {
|
|
1391
|
+
"value": {
|
|
1392
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1393
|
+
"title": "Bad Request",
|
|
1394
|
+
"detail": "Invalid time parameter 'from'. Must be a Unix epoch timestamp in seconds (e.g., 1672531200).",
|
|
1395
|
+
"parameter": "from"
|
|
1396
|
+
}
|
|
1397
|
+
},
|
|
1398
|
+
"InvalidTimeRangeExample": {
|
|
1399
|
+
"value": {
|
|
1400
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1401
|
+
"title": "Bad Request",
|
|
1402
|
+
"detail": "Invalid time range: 'from' (1672534800) must be earlier than 'to' (1672531200).",
|
|
1403
|
+
"fromValue": 1672534800,
|
|
1404
|
+
"toValue": 1672531200
|
|
1405
|
+
}
|
|
1406
|
+
},
|
|
1407
|
+
"InvalidApiFamilyExample": {
|
|
1408
|
+
"value": {
|
|
1409
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1410
|
+
"title": "Bad Request",
|
|
1411
|
+
"detail": "Invalid value 'invalid-family' for filter 'apiFamily'.",
|
|
1412
|
+
"filterName": "apiFamily",
|
|
1413
|
+
"filterValue": "invalid-family"
|
|
1414
|
+
}
|
|
1415
|
+
},
|
|
1416
|
+
"InvalidApiNameExample": {
|
|
1417
|
+
"value": {
|
|
1418
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1419
|
+
"title": "Bad Request",
|
|
1420
|
+
"detail": "Invalid value 'unknown-api' for filter 'apiName'.",
|
|
1421
|
+
"filterName": "apiName",
|
|
1422
|
+
"filterValue": "unknown-api"
|
|
1423
|
+
}
|
|
1424
|
+
},
|
|
1425
|
+
"InvalidTimeParameterErrorResponseExample": {
|
|
1426
|
+
"$ref": "#/components/examples/InvalidTimeParameterErrorResponseExample"
|
|
1427
|
+
},
|
|
1428
|
+
"InvalidTimeRangeErrorResponseExample": {
|
|
1429
|
+
"$ref": "#/components/examples/InvalidTimeRangeErrorResponseExample"
|
|
1430
|
+
},
|
|
1431
|
+
"InvalidApiFilterErrorResponseExample": {
|
|
1432
|
+
"$ref": "#/components/examples/InvalidApiFilterErrorResponseExample"
|
|
1433
|
+
}
|
|
1079
1434
|
}
|
|
1080
1435
|
}
|
|
1081
1436
|
}
|
|
@@ -1086,6 +1441,11 @@
|
|
|
1086
1441
|
"application/json": {
|
|
1087
1442
|
"schema": {
|
|
1088
1443
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1444
|
+
},
|
|
1445
|
+
"examples": {
|
|
1446
|
+
"ScapiHooksMetricsResponseExample": {
|
|
1447
|
+
"$ref": "#/components/examples/ScapiHooksMetricsResponseExample"
|
|
1448
|
+
}
|
|
1089
1449
|
}
|
|
1090
1450
|
}
|
|
1091
1451
|
}
|
|
@@ -1096,6 +1456,11 @@
|
|
|
1096
1456
|
"application/json": {
|
|
1097
1457
|
"schema": {
|
|
1098
1458
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1459
|
+
},
|
|
1460
|
+
"examples": {
|
|
1461
|
+
"MrtMetricsResponseExample": {
|
|
1462
|
+
"$ref": "#/components/examples/MrtMetricsResponseExample"
|
|
1463
|
+
}
|
|
1099
1464
|
}
|
|
1100
1465
|
}
|
|
1101
1466
|
}
|
|
@@ -1106,6 +1471,11 @@
|
|
|
1106
1471
|
"application/json": {
|
|
1107
1472
|
"schema": {
|
|
1108
1473
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1474
|
+
},
|
|
1475
|
+
"examples": {
|
|
1476
|
+
"ControllerMetricsResponseExample": {
|
|
1477
|
+
"$ref": "#/components/examples/ControllerMetricsResponseExample"
|
|
1478
|
+
}
|
|
1109
1479
|
}
|
|
1110
1480
|
}
|
|
1111
1481
|
}
|
|
@@ -1116,6 +1486,11 @@
|
|
|
1116
1486
|
"application/json": {
|
|
1117
1487
|
"schema": {
|
|
1118
1488
|
"$ref": "#/components/schemas/MetricsDataResponse"
|
|
1489
|
+
},
|
|
1490
|
+
"examples": {
|
|
1491
|
+
"OcapiMetricsResponseExample": {
|
|
1492
|
+
"$ref": "#/components/examples/OcapiMetricsResponseExample"
|
|
1493
|
+
}
|
|
1119
1494
|
}
|
|
1120
1495
|
}
|
|
1121
1496
|
}
|
|
@@ -1136,6 +1511,43 @@
|
|
|
1136
1511
|
"$ref": "#/components/schemas/InvalidApiFilterErrorResponse"
|
|
1137
1512
|
}
|
|
1138
1513
|
]
|
|
1514
|
+
},
|
|
1515
|
+
"examples": {
|
|
1516
|
+
"InvalidTimeParameterExample": {
|
|
1517
|
+
"value": {
|
|
1518
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1519
|
+
"title": "Bad Request",
|
|
1520
|
+
"detail": "Invalid time parameter 'from'. Must be a Unix epoch timestamp in seconds (e.g., 1672531200).",
|
|
1521
|
+
"parameter": "from"
|
|
1522
|
+
}
|
|
1523
|
+
},
|
|
1524
|
+
"InvalidTimeRangeExample": {
|
|
1525
|
+
"value": {
|
|
1526
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1527
|
+
"title": "Bad Request",
|
|
1528
|
+
"detail": "Invalid time range: 'from' (1672534800) must be earlier than 'to' (1672531200).",
|
|
1529
|
+
"fromValue": 1672534800,
|
|
1530
|
+
"toValue": 1672531200
|
|
1531
|
+
}
|
|
1532
|
+
},
|
|
1533
|
+
"InvalidOcapiApiExample": {
|
|
1534
|
+
"value": {
|
|
1535
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
|
|
1536
|
+
"title": "Bad Request",
|
|
1537
|
+
"detail": "Invalid value 'unknown-api' for filter 'ocapiApi'.",
|
|
1538
|
+
"filterName": "ocapiApi",
|
|
1539
|
+
"filterValue": "unknown-api"
|
|
1540
|
+
}
|
|
1541
|
+
},
|
|
1542
|
+
"InvalidTimeParameterErrorResponseExample": {
|
|
1543
|
+
"$ref": "#/components/examples/InvalidTimeParameterErrorResponseExample"
|
|
1544
|
+
},
|
|
1545
|
+
"InvalidTimeRangeErrorResponseExample": {
|
|
1546
|
+
"$ref": "#/components/examples/InvalidTimeRangeErrorResponseExample"
|
|
1547
|
+
},
|
|
1548
|
+
"InvalidApiFilterErrorResponseExample": {
|
|
1549
|
+
"$ref": "#/components/examples/InvalidApiFilterErrorResponseExample"
|
|
1550
|
+
}
|
|
1139
1551
|
}
|
|
1140
1552
|
}
|
|
1141
1553
|
}
|
|
@@ -1145,40 +1557,47 @@
|
|
|
1145
1557
|
"organizationId": {
|
|
1146
1558
|
"name": "organizationId",
|
|
1147
1559
|
"in": "path",
|
|
1560
|
+
"description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
|
|
1148
1561
|
"required": true,
|
|
1149
1562
|
"style": "simple",
|
|
1150
1563
|
"explode": false,
|
|
1151
1564
|
"schema": {
|
|
1152
1565
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1153
|
-
}
|
|
1566
|
+
},
|
|
1567
|
+
"example": "f_ecom_zzxy_prd"
|
|
1154
1568
|
},
|
|
1155
1569
|
"from": {
|
|
1156
1570
|
"name": "from",
|
|
1157
1571
|
"in": "query",
|
|
1572
|
+
"description": "Start time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to one hour before `to`.\n\nConstraints:\n- `from` must not resolve to a time more than 30 days before the request (matches the configured retention of the underlying metrics store).\n- `to` minus `from` must not exceed 1 day.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
1158
1573
|
"required": false,
|
|
1159
1574
|
"style": "form",
|
|
1160
1575
|
"explode": true,
|
|
1161
1576
|
"schema": {
|
|
1162
1577
|
"type": "integer",
|
|
1163
1578
|
"format": "int64",
|
|
1579
|
+
"example": 1672531200,
|
|
1164
1580
|
"minimum": 1
|
|
1165
1581
|
}
|
|
1166
1582
|
},
|
|
1167
1583
|
"to": {
|
|
1168
1584
|
"name": "to",
|
|
1169
1585
|
"in": "query",
|
|
1586
|
+
"description": "End time for the query window, expressed as a Unix epoch timestamp in seconds.\n\nIf not specified, defaults to the current time (now).\n\nConstraints:\n- `to` minus `from` must not exceed 1 day.\n- `from` must not resolve to a time more than 30 days before the request.\n\nRequests violating either constraint return `400 Bad Request`.\n",
|
|
1170
1587
|
"required": false,
|
|
1171
1588
|
"style": "form",
|
|
1172
1589
|
"explode": true,
|
|
1173
1590
|
"schema": {
|
|
1174
1591
|
"type": "integer",
|
|
1175
1592
|
"format": "int64",
|
|
1593
|
+
"example": 1672534800,
|
|
1176
1594
|
"minimum": 1
|
|
1177
1595
|
}
|
|
1178
1596
|
},
|
|
1179
1597
|
"thirdPartyServiceId": {
|
|
1180
1598
|
"name": "thirdPartyServiceId",
|
|
1181
1599
|
"in": "query",
|
|
1600
|
+
"description": "Filter by a specific third party service identifier (typically a hostname,\ne.g. `apple-pay-gateway.apple.com`). The list of services is customer-configured;\nomit this parameter to get one data series per (realm, third party service).\n",
|
|
1182
1601
|
"required": false,
|
|
1183
1602
|
"style": "form",
|
|
1184
1603
|
"explode": true,
|
|
@@ -1189,11 +1608,13 @@
|
|
|
1189
1608
|
"apiFamily": {
|
|
1190
1609
|
"name": "apiFamily",
|
|
1191
1610
|
"in": "query",
|
|
1611
|
+
"description": "Filter by SCAPI family name",
|
|
1192
1612
|
"required": false,
|
|
1193
1613
|
"style": "form",
|
|
1194
1614
|
"explode": true,
|
|
1195
1615
|
"schema": {
|
|
1196
1616
|
"type": "string",
|
|
1617
|
+
"example": "shopper",
|
|
1197
1618
|
"maxLength": 100,
|
|
1198
1619
|
"minLength": 1
|
|
1199
1620
|
}
|
|
@@ -1201,11 +1622,13 @@
|
|
|
1201
1622
|
"apiName": {
|
|
1202
1623
|
"name": "apiName",
|
|
1203
1624
|
"in": "query",
|
|
1625
|
+
"description": "Filter by specific SCAPI name",
|
|
1204
1626
|
"required": false,
|
|
1205
1627
|
"style": "form",
|
|
1206
1628
|
"explode": true,
|
|
1207
1629
|
"schema": {
|
|
1208
1630
|
"type": "string",
|
|
1631
|
+
"example": "products",
|
|
1209
1632
|
"maxLength": 100,
|
|
1210
1633
|
"minLength": 1
|
|
1211
1634
|
}
|
|
@@ -1213,11 +1636,13 @@
|
|
|
1213
1636
|
"ocapiCategory": {
|
|
1214
1637
|
"name": "ocapiCategory",
|
|
1215
1638
|
"in": "query",
|
|
1639
|
+
"description": "Filter by Open Commerce API category. Common values include `shop`, `data` and `mercury`.\nQueries with values that don't match any series return 200 with empty data.\n",
|
|
1216
1640
|
"required": false,
|
|
1217
1641
|
"style": "form",
|
|
1218
1642
|
"explode": true,
|
|
1219
1643
|
"schema": {
|
|
1220
1644
|
"type": "string",
|
|
1645
|
+
"example": "shop",
|
|
1221
1646
|
"maxLength": 100,
|
|
1222
1647
|
"minLength": 1
|
|
1223
1648
|
}
|
|
@@ -1225,35 +1650,824 @@
|
|
|
1225
1650
|
"ocapiApi": {
|
|
1226
1651
|
"name": "ocapiApi",
|
|
1227
1652
|
"in": "query",
|
|
1653
|
+
"description": "Filter by specific Open Commerce API endpoint (e.g. `baskets`).",
|
|
1228
1654
|
"required": false,
|
|
1229
1655
|
"style": "form",
|
|
1230
1656
|
"explode": true,
|
|
1231
1657
|
"schema": {
|
|
1232
1658
|
"type": "string",
|
|
1659
|
+
"example": "baskets",
|
|
1233
1660
|
"maxLength": 100,
|
|
1234
1661
|
"minLength": 1
|
|
1235
1662
|
}
|
|
1236
1663
|
}
|
|
1237
1664
|
},
|
|
1665
|
+
"examples": {
|
|
1666
|
+
"OverallMetricsResponseExample": {
|
|
1667
|
+
"summary": "Overall Application metrics response",
|
|
1668
|
+
"value": {
|
|
1669
|
+
"data": [
|
|
1670
|
+
{
|
|
1671
|
+
"metricId": "totalCalls",
|
|
1672
|
+
"title": "Total Platform Requests",
|
|
1673
|
+
"description": "Total number of platform requests per minute.",
|
|
1674
|
+
"unit": "requests/min",
|
|
1675
|
+
"dataSeries": [
|
|
1676
|
+
{
|
|
1677
|
+
"id": "realm1.totalCalls",
|
|
1678
|
+
"name": "realm1 Total Calls",
|
|
1679
|
+
"data": [
|
|
1680
|
+
{
|
|
1681
|
+
"timestamp": 1640995200,
|
|
1682
|
+
"value": 1250.5
|
|
1683
|
+
},
|
|
1684
|
+
{
|
|
1685
|
+
"timestamp": 1640995260,
|
|
1686
|
+
"value": 1275.2
|
|
1687
|
+
},
|
|
1688
|
+
{
|
|
1689
|
+
"timestamp": 1640995320,
|
|
1690
|
+
"value": 1201.8
|
|
1691
|
+
}
|
|
1692
|
+
]
|
|
1693
|
+
}
|
|
1694
|
+
]
|
|
1695
|
+
},
|
|
1696
|
+
{
|
|
1697
|
+
"metricId": "sessions",
|
|
1698
|
+
"title": "Sessions",
|
|
1699
|
+
"description": "Number of active sessions across all sites per minute.",
|
|
1700
|
+
"unit": "sessions/min",
|
|
1701
|
+
"dataSeries": [
|
|
1702
|
+
{
|
|
1703
|
+
"id": "realm1.sessions",
|
|
1704
|
+
"name": "realm1 Sessions",
|
|
1705
|
+
"data": [
|
|
1706
|
+
{
|
|
1707
|
+
"timestamp": 1640995200,
|
|
1708
|
+
"value": 45.2
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
"timestamp": 1640995260,
|
|
1712
|
+
"value": 47.1
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
"timestamp": 1640995320,
|
|
1716
|
+
"value": 44.8
|
|
1717
|
+
}
|
|
1718
|
+
]
|
|
1719
|
+
}
|
|
1720
|
+
]
|
|
1721
|
+
},
|
|
1722
|
+
{
|
|
1723
|
+
"metricId": "responseTime",
|
|
1724
|
+
"title": "Response Time",
|
|
1725
|
+
"description": "Average response time across all requests.",
|
|
1726
|
+
"unit": "ms",
|
|
1727
|
+
"dataSeries": [
|
|
1728
|
+
{
|
|
1729
|
+
"id": "realm1.responseTime",
|
|
1730
|
+
"name": "realm1 Response Time",
|
|
1731
|
+
"data": [
|
|
1732
|
+
{
|
|
1733
|
+
"timestamp": 1640995200,
|
|
1734
|
+
"value": 156.3
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
"timestamp": 1640995260,
|
|
1738
|
+
"value": 148.7
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"timestamp": 1640995320,
|
|
1742
|
+
"value": 162.1
|
|
1743
|
+
}
|
|
1744
|
+
]
|
|
1745
|
+
}
|
|
1746
|
+
]
|
|
1747
|
+
}
|
|
1748
|
+
]
|
|
1749
|
+
}
|
|
1750
|
+
},
|
|
1751
|
+
"UnauthorizedExample": {
|
|
1752
|
+
"value": {
|
|
1753
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized",
|
|
1754
|
+
"title": "Unauthorized",
|
|
1755
|
+
"detail": "Unauthorized request"
|
|
1756
|
+
}
|
|
1757
|
+
},
|
|
1758
|
+
"ForbiddenExample": {
|
|
1759
|
+
"value": {
|
|
1760
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden",
|
|
1761
|
+
"title": "Forbidden",
|
|
1762
|
+
"detail": "Access to requested resource forbidden"
|
|
1763
|
+
}
|
|
1764
|
+
},
|
|
1765
|
+
"SalesMetricsResponseExample": {
|
|
1766
|
+
"summary": "Sales metrics response",
|
|
1767
|
+
"value": {
|
|
1768
|
+
"data": [
|
|
1769
|
+
{
|
|
1770
|
+
"metricId": "orders",
|
|
1771
|
+
"title": "Orders",
|
|
1772
|
+
"description": "Number of orders created across all sites per minute.",
|
|
1773
|
+
"unit": "orders/min",
|
|
1774
|
+
"dataSeries": [
|
|
1775
|
+
{
|
|
1776
|
+
"id": "realm1.orders",
|
|
1777
|
+
"name": "realm1 Orders",
|
|
1778
|
+
"data": [
|
|
1779
|
+
{
|
|
1780
|
+
"timestamp": 1640995200,
|
|
1781
|
+
"value": 25.3
|
|
1782
|
+
},
|
|
1783
|
+
{
|
|
1784
|
+
"timestamp": 1640995260,
|
|
1785
|
+
"value": 27.1
|
|
1786
|
+
},
|
|
1787
|
+
{
|
|
1788
|
+
"timestamp": 1640995320,
|
|
1789
|
+
"value": 23.8
|
|
1790
|
+
}
|
|
1791
|
+
]
|
|
1792
|
+
}
|
|
1793
|
+
]
|
|
1794
|
+
},
|
|
1795
|
+
{
|
|
1796
|
+
"metricId": "basketCreations",
|
|
1797
|
+
"title": "Basket Creations",
|
|
1798
|
+
"description": "Number of baskets created across all sites per minute.",
|
|
1799
|
+
"unit": "baskets/min",
|
|
1800
|
+
"dataSeries": [
|
|
1801
|
+
{
|
|
1802
|
+
"id": "realm1.basketCreations",
|
|
1803
|
+
"name": "realm1 Basket Creations",
|
|
1804
|
+
"data": [
|
|
1805
|
+
{
|
|
1806
|
+
"timestamp": 1640995200,
|
|
1807
|
+
"value": 85.2
|
|
1808
|
+
},
|
|
1809
|
+
{
|
|
1810
|
+
"timestamp": 1640995260,
|
|
1811
|
+
"value": 89.1
|
|
1812
|
+
},
|
|
1813
|
+
{
|
|
1814
|
+
"timestamp": 1640995320,
|
|
1815
|
+
"value": 82.5
|
|
1816
|
+
}
|
|
1817
|
+
]
|
|
1818
|
+
}
|
|
1819
|
+
]
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"metricId": "basketUpdates",
|
|
1823
|
+
"title": "Basket Updates",
|
|
1824
|
+
"description": "Number of basket updates across all sites per minute.",
|
|
1825
|
+
"unit": "updates/min",
|
|
1826
|
+
"dataSeries": [
|
|
1827
|
+
{
|
|
1828
|
+
"id": "realm1.basketUpdates",
|
|
1829
|
+
"name": "realm1 Basket Updates",
|
|
1830
|
+
"data": [
|
|
1831
|
+
{
|
|
1832
|
+
"timestamp": 1640995200,
|
|
1833
|
+
"value": 142.7
|
|
1834
|
+
},
|
|
1835
|
+
{
|
|
1836
|
+
"timestamp": 1640995260,
|
|
1837
|
+
"value": 138.9
|
|
1838
|
+
},
|
|
1839
|
+
{
|
|
1840
|
+
"timestamp": 1640995320,
|
|
1841
|
+
"value": 156.3
|
|
1842
|
+
}
|
|
1843
|
+
]
|
|
1844
|
+
}
|
|
1845
|
+
]
|
|
1846
|
+
}
|
|
1847
|
+
]
|
|
1848
|
+
}
|
|
1849
|
+
},
|
|
1850
|
+
"EcdnMetricsResponseExample": {
|
|
1851
|
+
"summary": "eCDN metrics response",
|
|
1852
|
+
"value": {
|
|
1853
|
+
"data": [
|
|
1854
|
+
{
|
|
1855
|
+
"metricId": "successAndError",
|
|
1856
|
+
"title": "Success and Errors",
|
|
1857
|
+
"description": "Total success and error requests per minute.",
|
|
1858
|
+
"unit": "requests/min",
|
|
1859
|
+
"dataSeries": [
|
|
1860
|
+
{
|
|
1861
|
+
"id": "realm1.successAndError",
|
|
1862
|
+
"name": "realm1 Success and Errors",
|
|
1863
|
+
"data": [
|
|
1864
|
+
{
|
|
1865
|
+
"timestamp": 1640995200,
|
|
1866
|
+
"value": 8945.2
|
|
1867
|
+
},
|
|
1868
|
+
{
|
|
1869
|
+
"timestamp": 1640995260,
|
|
1870
|
+
"value": 9103.7
|
|
1871
|
+
},
|
|
1872
|
+
{
|
|
1873
|
+
"timestamp": 1640995320,
|
|
1874
|
+
"value": 8876.1
|
|
1875
|
+
}
|
|
1876
|
+
]
|
|
1877
|
+
}
|
|
1878
|
+
]
|
|
1879
|
+
},
|
|
1880
|
+
{
|
|
1881
|
+
"metricId": "cacheHits",
|
|
1882
|
+
"title": "Cache Hit Percentage",
|
|
1883
|
+
"description": "Percentage of requests served from cache.",
|
|
1884
|
+
"unit": "percentage",
|
|
1885
|
+
"dataSeries": [
|
|
1886
|
+
{
|
|
1887
|
+
"id": "realm1.cacheHits",
|
|
1888
|
+
"name": "realm1 Cache Hit Percentage",
|
|
1889
|
+
"data": [
|
|
1890
|
+
{
|
|
1891
|
+
"timestamp": 1640995200,
|
|
1892
|
+
"value": 87.3
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
"timestamp": 1640995260,
|
|
1896
|
+
"value": 89.1
|
|
1897
|
+
},
|
|
1898
|
+
{
|
|
1899
|
+
"timestamp": 1640995320,
|
|
1900
|
+
"value": 85.7
|
|
1901
|
+
}
|
|
1902
|
+
]
|
|
1903
|
+
}
|
|
1904
|
+
]
|
|
1905
|
+
},
|
|
1906
|
+
{
|
|
1907
|
+
"metricId": "totalBandwidth",
|
|
1908
|
+
"title": "Total Bandwidth",
|
|
1909
|
+
"description": "Total bandwidth usage per minute.",
|
|
1910
|
+
"unit": "bytes/min",
|
|
1911
|
+
"dataSeries": [
|
|
1912
|
+
{
|
|
1913
|
+
"id": "realm1.totalBandwidth",
|
|
1914
|
+
"name": "realm1 Total Bandwidth",
|
|
1915
|
+
"data": [
|
|
1916
|
+
{
|
|
1917
|
+
"timestamp": 1640995200,
|
|
1918
|
+
"value": 2048576000
|
|
1919
|
+
},
|
|
1920
|
+
{
|
|
1921
|
+
"timestamp": 1640995260,
|
|
1922
|
+
"value": 2156789123
|
|
1923
|
+
},
|
|
1924
|
+
{
|
|
1925
|
+
"timestamp": 1640995320,
|
|
1926
|
+
"value": 1987654321
|
|
1927
|
+
}
|
|
1928
|
+
]
|
|
1929
|
+
}
|
|
1930
|
+
]
|
|
1931
|
+
}
|
|
1932
|
+
]
|
|
1933
|
+
}
|
|
1934
|
+
},
|
|
1935
|
+
"ThirdPartyMetricsResponseExample": {
|
|
1936
|
+
"summary": "Third Party Services metrics response",
|
|
1937
|
+
"value": {
|
|
1938
|
+
"data": [
|
|
1939
|
+
{
|
|
1940
|
+
"metricId": "callCounts",
|
|
1941
|
+
"title": "Call Counts",
|
|
1942
|
+
"description": "Number of calls to third party services per minute.",
|
|
1943
|
+
"unit": "calls/min",
|
|
1944
|
+
"dataSeries": [
|
|
1945
|
+
{
|
|
1946
|
+
"id": "realm1.apple-pay-gateway.apple.com",
|
|
1947
|
+
"name": "realm1 apple-pay-gateway.apple.com Call Counts",
|
|
1948
|
+
"data": [
|
|
1949
|
+
{
|
|
1950
|
+
"timestamp": 1640995200,
|
|
1951
|
+
"value": 156
|
|
1952
|
+
},
|
|
1953
|
+
{
|
|
1954
|
+
"timestamp": 1640995260,
|
|
1955
|
+
"value": 163
|
|
1956
|
+
},
|
|
1957
|
+
{
|
|
1958
|
+
"timestamp": 1640995320,
|
|
1959
|
+
"value": 149
|
|
1960
|
+
}
|
|
1961
|
+
]
|
|
1962
|
+
}
|
|
1963
|
+
]
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"metricId": "callDurationP95",
|
|
1967
|
+
"title": "Call Duration P95",
|
|
1968
|
+
"description": "95th percentile of call duration to third party services.",
|
|
1969
|
+
"unit": "ms",
|
|
1970
|
+
"dataSeries": [
|
|
1971
|
+
{
|
|
1972
|
+
"id": "realm1.apple-pay-gateway.apple.com",
|
|
1973
|
+
"name": "realm1 apple-pay-gateway.apple.com Call Duration P95",
|
|
1974
|
+
"data": [
|
|
1975
|
+
{
|
|
1976
|
+
"timestamp": 1640995200,
|
|
1977
|
+
"value": 425.7
|
|
1978
|
+
},
|
|
1979
|
+
{
|
|
1980
|
+
"timestamp": 1640995260,
|
|
1981
|
+
"value": 398.2
|
|
1982
|
+
},
|
|
1983
|
+
{
|
|
1984
|
+
"timestamp": 1640995320,
|
|
1985
|
+
"value": 467.3
|
|
1986
|
+
}
|
|
1987
|
+
]
|
|
1988
|
+
}
|
|
1989
|
+
]
|
|
1990
|
+
},
|
|
1991
|
+
{
|
|
1992
|
+
"metricId": "remoteExceptions",
|
|
1993
|
+
"title": "Remote Exceptions",
|
|
1994
|
+
"description": "Number of exceptions from third party services per minute.",
|
|
1995
|
+
"unit": "exceptions/min",
|
|
1996
|
+
"dataSeries": [
|
|
1997
|
+
{
|
|
1998
|
+
"id": "realm1.apple-pay-gateway.apple.com",
|
|
1999
|
+
"name": "realm1 apple-pay-gateway.apple.com Remote Exceptions",
|
|
2000
|
+
"data": [
|
|
2001
|
+
{
|
|
2002
|
+
"timestamp": 1640995200,
|
|
2003
|
+
"value": 2
|
|
2004
|
+
},
|
|
2005
|
+
{
|
|
2006
|
+
"timestamp": 1640995260,
|
|
2007
|
+
"value": 1
|
|
2008
|
+
},
|
|
2009
|
+
{
|
|
2010
|
+
"timestamp": 1640995320,
|
|
2011
|
+
"value": 3
|
|
2012
|
+
}
|
|
2013
|
+
]
|
|
2014
|
+
}
|
|
2015
|
+
]
|
|
2016
|
+
}
|
|
2017
|
+
]
|
|
2018
|
+
}
|
|
2019
|
+
},
|
|
2020
|
+
"ScapiMetricsResponseExample": {
|
|
2021
|
+
"summary": "SCAPI metrics response with filters",
|
|
2022
|
+
"value": {
|
|
2023
|
+
"data": [
|
|
2024
|
+
{
|
|
2025
|
+
"metricId": "requestLatency",
|
|
2026
|
+
"title": "Request Latency",
|
|
2027
|
+
"description": "Average request latency for SCAPI calls.",
|
|
2028
|
+
"unit": "ms",
|
|
2029
|
+
"dataSeries": [
|
|
2030
|
+
{
|
|
2031
|
+
"id": "realm1.shopper.products.requestLatency",
|
|
2032
|
+
"name": "realm1 Shopper Products Request Latency",
|
|
2033
|
+
"data": [
|
|
2034
|
+
{
|
|
2035
|
+
"timestamp": 1640995200,
|
|
2036
|
+
"value": 245.7
|
|
2037
|
+
},
|
|
2038
|
+
{
|
|
2039
|
+
"timestamp": 1640995260,
|
|
2040
|
+
"value": 231.2
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"timestamp": 1640995320,
|
|
2044
|
+
"value": 267.8
|
|
2045
|
+
}
|
|
2046
|
+
]
|
|
2047
|
+
}
|
|
2048
|
+
]
|
|
2049
|
+
},
|
|
2050
|
+
{
|
|
2051
|
+
"metricId": "responseCount",
|
|
2052
|
+
"title": "Response Count",
|
|
2053
|
+
"description": "Number of SCAPI responses per minute.",
|
|
2054
|
+
"unit": "responses/min",
|
|
2055
|
+
"dataSeries": [
|
|
2056
|
+
{
|
|
2057
|
+
"id": "realm1.shopper.products.responseCount",
|
|
2058
|
+
"name": "realm1 Shopper Products Response Count",
|
|
2059
|
+
"data": [
|
|
2060
|
+
{
|
|
2061
|
+
"timestamp": 1640995200,
|
|
2062
|
+
"value": 1456
|
|
2063
|
+
},
|
|
2064
|
+
{
|
|
2065
|
+
"timestamp": 1640995260,
|
|
2066
|
+
"value": 1523
|
|
2067
|
+
},
|
|
2068
|
+
{
|
|
2069
|
+
"timestamp": 1640995320,
|
|
2070
|
+
"value": 1389
|
|
2071
|
+
}
|
|
2072
|
+
]
|
|
2073
|
+
}
|
|
2074
|
+
]
|
|
2075
|
+
}
|
|
2076
|
+
]
|
|
2077
|
+
}
|
|
2078
|
+
},
|
|
2079
|
+
"ScapiHooksMetricsResponseExample": {
|
|
2080
|
+
"summary": "SCAPI Hooks metrics response",
|
|
2081
|
+
"value": {
|
|
2082
|
+
"data": [
|
|
2083
|
+
{
|
|
2084
|
+
"metricId": "hookExecutionTimes",
|
|
2085
|
+
"title": "Hook Execution Times",
|
|
2086
|
+
"description": "Average execution time for SCAPI hooks.",
|
|
2087
|
+
"unit": "ms",
|
|
2088
|
+
"dataSeries": [
|
|
2089
|
+
{
|
|
2090
|
+
"id": "realm1.hookExecutionTimes",
|
|
2091
|
+
"name": "realm1 Hook Execution Times",
|
|
2092
|
+
"data": [
|
|
2093
|
+
{
|
|
2094
|
+
"timestamp": 1640995200,
|
|
2095
|
+
"value": 45.3
|
|
2096
|
+
},
|
|
2097
|
+
{
|
|
2098
|
+
"timestamp": 1640995260,
|
|
2099
|
+
"value": 52.1
|
|
2100
|
+
},
|
|
2101
|
+
{
|
|
2102
|
+
"timestamp": 1640995320,
|
|
2103
|
+
"value": 38.7
|
|
2104
|
+
}
|
|
2105
|
+
]
|
|
2106
|
+
}
|
|
2107
|
+
]
|
|
2108
|
+
},
|
|
2109
|
+
{
|
|
2110
|
+
"metricId": "hookErrors",
|
|
2111
|
+
"title": "Hook Errors",
|
|
2112
|
+
"description": "Number of hook execution errors per minute.",
|
|
2113
|
+
"unit": "errors/min",
|
|
2114
|
+
"dataSeries": [
|
|
2115
|
+
{
|
|
2116
|
+
"id": "realm1.hookErrors",
|
|
2117
|
+
"name": "realm1 Hook Errors",
|
|
2118
|
+
"data": [
|
|
2119
|
+
{
|
|
2120
|
+
"timestamp": 1640995200,
|
|
2121
|
+
"value": 0.5
|
|
2122
|
+
},
|
|
2123
|
+
{
|
|
2124
|
+
"timestamp": 1640995260,
|
|
2125
|
+
"value": 1
|
|
2126
|
+
},
|
|
2127
|
+
{
|
|
2128
|
+
"timestamp": 1640995320,
|
|
2129
|
+
"value": 0
|
|
2130
|
+
}
|
|
2131
|
+
]
|
|
2132
|
+
}
|
|
2133
|
+
]
|
|
2134
|
+
}
|
|
2135
|
+
]
|
|
2136
|
+
}
|
|
2137
|
+
},
|
|
2138
|
+
"MrtMetricsResponseExample": {
|
|
2139
|
+
"summary": "Managed Runtime metrics response",
|
|
2140
|
+
"value": {
|
|
2141
|
+
"data": [
|
|
2142
|
+
{
|
|
2143
|
+
"metricId": "requestCount",
|
|
2144
|
+
"title": "Request Count",
|
|
2145
|
+
"description": "Number of MRT requests per minute.",
|
|
2146
|
+
"unit": "requests/min",
|
|
2147
|
+
"dataSeries": [
|
|
2148
|
+
{
|
|
2149
|
+
"id": "realm1.requestCount",
|
|
2150
|
+
"name": "realm1 Request Count",
|
|
2151
|
+
"data": [
|
|
2152
|
+
{
|
|
2153
|
+
"timestamp": 1640995200,
|
|
2154
|
+
"value": 789.2
|
|
2155
|
+
},
|
|
2156
|
+
{
|
|
2157
|
+
"timestamp": 1640995260,
|
|
2158
|
+
"value": 823.4
|
|
2159
|
+
},
|
|
2160
|
+
{
|
|
2161
|
+
"timestamp": 1640995320,
|
|
2162
|
+
"value": 756.1
|
|
2163
|
+
}
|
|
2164
|
+
]
|
|
2165
|
+
}
|
|
2166
|
+
]
|
|
2167
|
+
},
|
|
2168
|
+
{
|
|
2169
|
+
"metricId": "cacheHitRates",
|
|
2170
|
+
"title": "Cache Hit Rates",
|
|
2171
|
+
"description": "Percentage of requests served from MRT cache.",
|
|
2172
|
+
"unit": "percentage",
|
|
2173
|
+
"dataSeries": [
|
|
2174
|
+
{
|
|
2175
|
+
"id": "realm1.cacheHitRates",
|
|
2176
|
+
"name": "realm1 Cache Hit Rates",
|
|
2177
|
+
"data": [
|
|
2178
|
+
{
|
|
2179
|
+
"timestamp": 1640995200,
|
|
2180
|
+
"value": 92.3
|
|
2181
|
+
},
|
|
2182
|
+
{
|
|
2183
|
+
"timestamp": 1640995260,
|
|
2184
|
+
"value": 94.1
|
|
2185
|
+
},
|
|
2186
|
+
{
|
|
2187
|
+
"timestamp": 1640995320,
|
|
2188
|
+
"value": 89.7
|
|
2189
|
+
}
|
|
2190
|
+
]
|
|
2191
|
+
}
|
|
2192
|
+
]
|
|
2193
|
+
},
|
|
2194
|
+
{
|
|
2195
|
+
"metricId": "errorRates",
|
|
2196
|
+
"title": "Error Rates",
|
|
2197
|
+
"description": "Percentage of MRT requests that resulted in errors.",
|
|
2198
|
+
"unit": "percentage",
|
|
2199
|
+
"dataSeries": [
|
|
2200
|
+
{
|
|
2201
|
+
"id": "realm1.errorRates",
|
|
2202
|
+
"name": "realm1 Error Rates",
|
|
2203
|
+
"data": [
|
|
2204
|
+
{
|
|
2205
|
+
"timestamp": 1640995200,
|
|
2206
|
+
"value": 0.8
|
|
2207
|
+
},
|
|
2208
|
+
{
|
|
2209
|
+
"timestamp": 1640995260,
|
|
2210
|
+
"value": 1.2
|
|
2211
|
+
},
|
|
2212
|
+
{
|
|
2213
|
+
"timestamp": 1640995320,
|
|
2214
|
+
"value": 0.5
|
|
2215
|
+
}
|
|
2216
|
+
]
|
|
2217
|
+
}
|
|
2218
|
+
]
|
|
2219
|
+
},
|
|
2220
|
+
{
|
|
2221
|
+
"metricId": "lambdaInvocations",
|
|
2222
|
+
"title": "Lambda Invocations",
|
|
2223
|
+
"description": "Number of Lambda function invocations per minute.",
|
|
2224
|
+
"unit": "invocations/min",
|
|
2225
|
+
"dataSeries": [
|
|
2226
|
+
{
|
|
2227
|
+
"id": "realm1.lambdaInvocations",
|
|
2228
|
+
"name": "realm1 Lambda Invocations",
|
|
2229
|
+
"data": [
|
|
2230
|
+
{
|
|
2231
|
+
"timestamp": 1640995200,
|
|
2232
|
+
"value": 234
|
|
2233
|
+
},
|
|
2234
|
+
{
|
|
2235
|
+
"timestamp": 1640995260,
|
|
2236
|
+
"value": 267
|
|
2237
|
+
},
|
|
2238
|
+
{
|
|
2239
|
+
"timestamp": 1640995320,
|
|
2240
|
+
"value": 201
|
|
2241
|
+
}
|
|
2242
|
+
]
|
|
2243
|
+
}
|
|
2244
|
+
]
|
|
2245
|
+
},
|
|
2246
|
+
{
|
|
2247
|
+
"metricId": "requestTimes",
|
|
2248
|
+
"title": "Request Times",
|
|
2249
|
+
"description": "Average request processing time in MRT.",
|
|
2250
|
+
"unit": "ms",
|
|
2251
|
+
"dataSeries": [
|
|
2252
|
+
{
|
|
2253
|
+
"id": "realm1.requestTimes",
|
|
2254
|
+
"name": "realm1 Request Times",
|
|
2255
|
+
"data": [
|
|
2256
|
+
{
|
|
2257
|
+
"timestamp": 1640995200,
|
|
2258
|
+
"value": 123.4
|
|
2259
|
+
},
|
|
2260
|
+
{
|
|
2261
|
+
"timestamp": 1640995260,
|
|
2262
|
+
"value": 118.7
|
|
2263
|
+
},
|
|
2264
|
+
{
|
|
2265
|
+
"timestamp": 1640995320,
|
|
2266
|
+
"value": 134.2
|
|
2267
|
+
}
|
|
2268
|
+
]
|
|
2269
|
+
}
|
|
2270
|
+
]
|
|
2271
|
+
}
|
|
2272
|
+
]
|
|
2273
|
+
}
|
|
2274
|
+
},
|
|
2275
|
+
"ControllerMetricsResponseExample": {
|
|
2276
|
+
"summary": "Controller metrics response",
|
|
2277
|
+
"value": {
|
|
2278
|
+
"data": [
|
|
2279
|
+
{
|
|
2280
|
+
"metricId": "totalCalls",
|
|
2281
|
+
"title": "Total Calls",
|
|
2282
|
+
"description": "Number of controller invocations per minute.",
|
|
2283
|
+
"unit": "calls/min",
|
|
2284
|
+
"dataSeries": [
|
|
2285
|
+
{
|
|
2286
|
+
"id": "realm1.totalCalls",
|
|
2287
|
+
"name": "realm1 Total Calls",
|
|
2288
|
+
"data": [
|
|
2289
|
+
{
|
|
2290
|
+
"timestamp": 1640995200,
|
|
2291
|
+
"value": 456.3
|
|
2292
|
+
},
|
|
2293
|
+
{
|
|
2294
|
+
"timestamp": 1640995260,
|
|
2295
|
+
"value": 489.1
|
|
2296
|
+
},
|
|
2297
|
+
{
|
|
2298
|
+
"timestamp": 1640995320,
|
|
2299
|
+
"value": 423.7
|
|
2300
|
+
}
|
|
2301
|
+
]
|
|
2302
|
+
}
|
|
2303
|
+
]
|
|
2304
|
+
},
|
|
2305
|
+
{
|
|
2306
|
+
"metricId": "averageDuration",
|
|
2307
|
+
"title": "Average Duration",
|
|
2308
|
+
"description": "Average controller processing time.",
|
|
2309
|
+
"unit": "ms",
|
|
2310
|
+
"dataSeries": [
|
|
2311
|
+
{
|
|
2312
|
+
"id": "realm1.averageDuration",
|
|
2313
|
+
"name": "realm1 Average Duration",
|
|
2314
|
+
"data": [
|
|
2315
|
+
{
|
|
2316
|
+
"timestamp": 1640995200,
|
|
2317
|
+
"value": 67.8
|
|
2318
|
+
},
|
|
2319
|
+
{
|
|
2320
|
+
"timestamp": 1640995260,
|
|
2321
|
+
"value": 72.3
|
|
2322
|
+
},
|
|
2323
|
+
{
|
|
2324
|
+
"timestamp": 1640995320,
|
|
2325
|
+
"value": 61.4
|
|
2326
|
+
}
|
|
2327
|
+
]
|
|
2328
|
+
}
|
|
2329
|
+
]
|
|
2330
|
+
}
|
|
2331
|
+
]
|
|
2332
|
+
}
|
|
2333
|
+
},
|
|
2334
|
+
"OcapiMetricsResponseExample": {
|
|
2335
|
+
"summary": "OCAPI metrics response with filters",
|
|
2336
|
+
"value": {
|
|
2337
|
+
"data": [
|
|
2338
|
+
{
|
|
2339
|
+
"metricId": "totalCalls",
|
|
2340
|
+
"title": "Total Calls",
|
|
2341
|
+
"description": "Number of OCAPI calls per minute.",
|
|
2342
|
+
"unit": "calls/min",
|
|
2343
|
+
"dataSeries": [
|
|
2344
|
+
{
|
|
2345
|
+
"id": "realm1.shop.baskets.totalCalls",
|
|
2346
|
+
"name": "realm1 Shop Baskets Total Calls",
|
|
2347
|
+
"data": [
|
|
2348
|
+
{
|
|
2349
|
+
"timestamp": 1640995200,
|
|
2350
|
+
"value": 234.5
|
|
2351
|
+
},
|
|
2352
|
+
{
|
|
2353
|
+
"timestamp": 1640995260,
|
|
2354
|
+
"value": 251.2
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
"timestamp": 1640995320,
|
|
2358
|
+
"value": 218.9
|
|
2359
|
+
}
|
|
2360
|
+
]
|
|
2361
|
+
}
|
|
2362
|
+
]
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
"metricId": "averageDuration",
|
|
2366
|
+
"title": "Average Duration",
|
|
2367
|
+
"description": "Average OCAPI response time.",
|
|
2368
|
+
"unit": "ms",
|
|
2369
|
+
"dataSeries": [
|
|
2370
|
+
{
|
|
2371
|
+
"id": "realm1.shop.baskets.averageDuration",
|
|
2372
|
+
"name": "realm1 Shop Baskets Average Duration",
|
|
2373
|
+
"data": [
|
|
2374
|
+
{
|
|
2375
|
+
"timestamp": 1640995200,
|
|
2376
|
+
"value": 89.3
|
|
2377
|
+
},
|
|
2378
|
+
{
|
|
2379
|
+
"timestamp": 1640995260,
|
|
2380
|
+
"value": 94.7
|
|
2381
|
+
},
|
|
2382
|
+
{
|
|
2383
|
+
"timestamp": 1640995320,
|
|
2384
|
+
"value": 82.1
|
|
2385
|
+
}
|
|
2386
|
+
]
|
|
2387
|
+
}
|
|
2388
|
+
]
|
|
2389
|
+
},
|
|
2390
|
+
{
|
|
2391
|
+
"metricId": "totalErrors",
|
|
2392
|
+
"title": "Total Errors",
|
|
2393
|
+
"description": "Number of OCAPI errors per minute.",
|
|
2394
|
+
"unit": "errors/min",
|
|
2395
|
+
"dataSeries": [
|
|
2396
|
+
{
|
|
2397
|
+
"id": "realm1.shop.baskets.totalErrors",
|
|
2398
|
+
"name": "realm1 Shop Baskets Total Errors",
|
|
2399
|
+
"data": [
|
|
2400
|
+
{
|
|
2401
|
+
"timestamp": 1640995200,
|
|
2402
|
+
"value": 3.2
|
|
2403
|
+
},
|
|
2404
|
+
{
|
|
2405
|
+
"timestamp": 1640995260,
|
|
2406
|
+
"value": 4.1
|
|
2407
|
+
},
|
|
2408
|
+
{
|
|
2409
|
+
"timestamp": 1640995320,
|
|
2410
|
+
"value": 2.7
|
|
2411
|
+
}
|
|
2412
|
+
]
|
|
2413
|
+
}
|
|
2414
|
+
]
|
|
2415
|
+
}
|
|
2416
|
+
]
|
|
2417
|
+
}
|
|
2418
|
+
},
|
|
2419
|
+
"InvalidTimeParameterErrorResponseExample": {
|
|
2420
|
+
"value": {
|
|
2421
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-time-parameter",
|
|
2422
|
+
"detail": "Invalid time parameter 'from'. Must be a Unix epoch timestamp in seconds (e.g., 1672531200).",
|
|
2423
|
+
"title": "Invalid Time Parameter"
|
|
2424
|
+
}
|
|
2425
|
+
},
|
|
2426
|
+
"InvalidTimeRangeErrorResponseExample": {
|
|
2427
|
+
"value": {
|
|
2428
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-time-range",
|
|
2429
|
+
"detail": "Invalid time range: 'from' (1672534800) must be earlier than 'to' (1672531200).",
|
|
2430
|
+
"title": "Invalid Time Range"
|
|
2431
|
+
}
|
|
2432
|
+
},
|
|
2433
|
+
"CategoryNotFoundErrorResponseExample": {
|
|
2434
|
+
"value": {
|
|
2435
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/category-not-found",
|
|
2436
|
+
"detail": "Metrics category 'unknown-category' not found or not available for organization 'f_ecom_zzxy_prd'.",
|
|
2437
|
+
"title": "Category Not Found"
|
|
2438
|
+
}
|
|
2439
|
+
},
|
|
2440
|
+
"MetricsNotAvailableErrorResponseExample": {
|
|
2441
|
+
"value": {
|
|
2442
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/metrics-not-available",
|
|
2443
|
+
"detail": "Metrics data is temporarily unavailable for organization 'f_ecom_zzxy_prd'. Please try again later.",
|
|
2444
|
+
"title": "Metrics Not Available"
|
|
2445
|
+
}
|
|
2446
|
+
},
|
|
2447
|
+
"InvalidThirdPartyServiceErrorResponseExample": {
|
|
2448
|
+
"value": {
|
|
2449
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-third-party-service",
|
|
2450
|
+
"detail": "Third party service 'apple-pay-gateway.apple.com' not found for organization 'f_ecom_zzxy_prd'.",
|
|
2451
|
+
"title": "Invalid Third Party Service"
|
|
2452
|
+
}
|
|
2453
|
+
},
|
|
2454
|
+
"InvalidApiFilterErrorResponseExample": {
|
|
2455
|
+
"value": {
|
|
2456
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-api-filter",
|
|
2457
|
+
"detail": "Invalid value 'invalid-family' for filter 'apiFamily'.",
|
|
2458
|
+
"title": "Invalid Api Filter"
|
|
2459
|
+
}
|
|
2460
|
+
}
|
|
2461
|
+
},
|
|
1238
2462
|
"securitySchemes": {
|
|
1239
2463
|
"AmOAuth2": {
|
|
1240
2464
|
"type": "oauth2",
|
|
2465
|
+
"description": "AccountManager OAuth 2.0 bearer token Authentication.",
|
|
1241
2466
|
"flows": {
|
|
1242
2467
|
"clientCredentials": {
|
|
1243
2468
|
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
1244
2469
|
"scopes": {
|
|
1245
|
-
"
|
|
1246
|
-
"sfcc.example": "standard salesforce commerce apis scopes must start with \"sfcc.\". Without suffix \".rw\" scopes grants READONLY access. [MAX length of scope 49 characters]",
|
|
1247
|
-
"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]"
|
|
1248
|
-
}
|
|
1249
|
-
},
|
|
1250
|
-
"authorizationCode": {
|
|
1251
|
-
"authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
|
|
1252
|
-
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|
|
1253
|
-
"scopes": {
|
|
1254
|
-
"c.example": "custom scopes mus start with c. used for custom APIs [MAX length of scope 49 characters]",
|
|
1255
|
-
"sfcc.example": "standard salesforce commerce apis scopes must start with \"sfcc.\". Without suffix \".rw\" scopes grants READONLY access. [MAX length of scope 49 characters]",
|
|
1256
|
-
"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]"
|
|
2470
|
+
"sfcc.metrics": "metrics READONLY"
|
|
1257
2471
|
}
|
|
1258
2472
|
}
|
|
1259
2473
|
}
|