--- title: Get a list of parked message metrics slug: import-test-pdf/Nayq-get-a-list-of-parked-message-metrics createdAt: 2025-10-27T13:00:23.930Z --- { "id": "JoYJ8xK-9v5VhQvXHpTB3", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics", "servers": [ { "url": "https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics", "description": "RS Provisioning Integration API" }, { "url": "https://provisioning.rs.{environment}.korfinancial.com/parked-message-metrics", "description": "RS Provisioning Production API" } ], "name": "Get a list of parked message metrics", "description": "Get a list of parked message metrics", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "entityId", "type": "string", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB", "description": "Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details." }, { "kind": "optional", "name": "dimension", "type": "string", "description": "

The time dimension to group the metrics by. When not provided, the default is FIVE_MIN.\n\n x-extensible-enum:

\n" }, { "kind": "optional", "name": "timeIntervalStart", "type": "string", "example": "2024-01-31T12:00:00Z", "description": "The start of the time interval to query the metrics for" }, { "kind": "optional", "name": "timeIntervalEnd", "type": "string", "example": "2024-01-31T12:05:00Z", "description": "The end of the time interval to query the metrics for" }, { "kind": "optional", "name": "userIdentifier", "type": "string", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB", "description": "The user identifier to query the metrics for" }, { "kind": "optional", "name": "jurisdiction", "type": "object", "description": "The jurisdiction to query the metrics for", "customType": "Jurisdiction", "schema": [], "modelRef": "#/components/schemas/Jurisdiction" }, { "kind": "optional", "name": "messageType", "type": "object", "description": "The message type to query the metrics for", "customType": "MessageType", "schema": [], "modelRef": "#/components/schemas/MessageType" }, { "kind": "optional", "name": "deliveryMechanism", "type": "object", "description": "The delivery mechanism of the parked message\n", "customType": "DeliveryMechanism", "schema": [], "modelRef": "#/components/schemas/DeliveryMechanism" }, { "kind": "optional", "name": "parkedType", "type": "object", "description": "The type of the parked message\n", "customType": "ParkedType", "schema": [], "modelRef": "#/components/schemas/ParkedType" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "The parked message metrics", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The search response with the parked message metrics", "customType": "ParkedMessageMetricsSearchResult", "schema": [ { "name": "cursor", "kind": "optional", "type": "string", "description": "Cursor for the current search request.", "example": "" }, { "name": "hasMore", "kind": "optional", "type": "boolean", "description": "Indicating whether there are more items that can be retrieved.", "example": "" }, { "name": "items", "kind": "required", "type": "array", "description": "The list of parked message metrics", "modelRef": "#/components/schemas/ParkedMessageMetric", "customType": "ParkedMessageMetric[]", "schema": [ { "name": "timeInterval", "kind": "optional", "type": "string", "description": "The startedTimestamp when parked message metric is created", "example": "2024-01-27T12:00:00Z" }, { "name": "userIdentifier", "kind": "optional", "type": "string", "description": "The user that caused the parked message metric", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "metrics", "kind": "optional", "type": "array", "description": "The list of metric details", "modelRef": "#/components/schemas/ParkedMessageMetricDetails", "customType": "ParkedMessageMetricDetails[]", "schema": [ { "name": "jurisdiction", "kind": "optional", "type": "string", "description": "The jurisdiction\n
x-extensible-enum: \n - CFTC\n - ESMA\n - ASIC\n - MAS\n - CA\n - FCA\n - ACER\n - SEC\n\n", "modelRef": "#/components/schemas/Jurisdiction", "customType": "Jurisdiction", "schema": [] }, { "name": "messageType", "kind": "optional", "type": "string", "description": "The message type\n
x-extensible-enum: \n - TRANSACTION\n - PUBLIC\n - VALUATION\n - COLLATERAL\n - DISPUTE\n\n", "modelRef": "#/components/schemas/MessageType", "customType": "MessageType", "schema": [] }, { "name": "deliveryMechanism", "kind": "optional", "type": "string", "description": "The delivery mechanism that upload was ingested\n
x-extensible-enum: \n - API\n - UI\n - KOR_SFTP\n - CLIENT_SFTP\n - KOR_KAFKA\n\n", "modelRef": "#/components/schemas/DeliveryMechanism", "customType": "DeliveryMechanism", "schema": [] }, { "name": "parkedType", "kind": "optional", "type": "string", "description": "The type of the parked message, reflecting the reason why it was parked\n
x-extensible-enum: \n - REHYDRATING_TRADE_STATE\n - PRIOR_UNRESOLVED_REJECTION\n - PRECEDING_TRADE_EVENT_PENDING\n - PRIOR_EVENT_AWAITING_UTI\n - DELAYED\n\n", "modelRef": "#/components/schemas/ParkedType", "customType": "ParkedType", "schema": [] }, { "name": "value", "kind": "optional", "type": "integer", "description": "The value of the metric", "example": 10 } ] } ] } ], "modelRef": "#/components/schemas/ParkedMessageMetricsSearchResult", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "405", "description": "Method Not Allowed", "jsonExample": "", "isExpanded": true }, { "statusCode": "406", "description": "Not Acceptable", "jsonExample": "", "isExpanded": true }, { "statusCode": "415", "description": "Unsupported Media Type", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true }, { "statusCode": "504", "description": "Gateway Timeout", "jsonExample": "", "isExpanded": true }, { "statusCode": "default", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics?jurisdiction=object&messageType=object&deliveryMechanism=object&parkedType=object' \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics?jurisdiction=object&messageType=object&deliveryMechanism=object&parkedType=object\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics?jurisdiction=object&messageType=object&deliveryMechanism=object&parkedType=object\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics?jurisdiction=object&messageType=object&deliveryMechanism=object&parkedType=object\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// The parked message metrics\n{\n \"cursor\": \"\",\n \"hasMore\": false,\n \"items\": [\n {\n \"timeInterval\": \"2024-01-27T12:00:00Z\",\n \"userIdentifier\": \"EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB\",\n \"metrics\": [\n {\n \"jurisdiction\": \"\",\n \"messageType\": \"\",\n \"deliveryMechanism\": \"\",\n \"parkedType\": \"\",\n \"value\": 10\n }\n ]\n }\n ]\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request\n" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-4-404", "language": "404", "code": "// Not Found\n" }, { "id": "response-5-405", "language": "405", "code": "// Method Not Allowed\n" }, { "id": "response-6-406", "language": "406", "code": "// Not Acceptable\n" }, { "id": "response-7-415", "language": "415", "code": "// Unsupported Media Type\n" }, { "id": "response-8-500", "language": "500", "code": "// Internal Server Error\n" }, { "id": "response-9-504", "language": "504", "code": "// Gateway Timeout\n" }, { "id": "response-10-default", "language": "default", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }