Get a list of parked message metrics

1 min

GET

https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics

Query Parameters

entityIdstring<uuid>
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.
dimensionstring
Description
The time dimension to group the metrics by. When not provided, the default is FIVE_MIN. x-extensible-enum:
- FIVE_MIN
- HOUR
- DAY
timeIntervalStartstring<datetime>
Example
2024-01-31T12:00:00Z
Description
The start of the time interval to query the metrics for
timeIntervalEndstring<datetime>
Example
2024-01-31T12:05:00Z
Description
The end of the time interval to query the metrics for
userIdentifierstring
Example
EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
Description
The user identifier to query the metrics for
jurisdictionJurisdiction
Description
The jurisdiction to query the metrics for
messageTypeMessageType
Description
The message type to query the metrics for
deliveryMechanismDeliveryMechanism
Description
The delivery mechanism of the parked message
parkedTypeParkedType
Description
The type of the parked message

Responses

200The parked message metrics

ParkedMessageMetricsSearchResult
Description
The search response with the parked message metrics
- cursorstring
  Description
  Cursor for the current search request.
- hasMoreboolean
  Description
  Indicating whether there are more items that can be retrieved.
- itemsParkedMessageMetric[]required
  Description
  The list of parked message metrics
  - timeIntervalstring<datetime>
    Example
    2024-01-27T12:00:00Z
    Description
    The startedTimestamp when parked message metric is created
  - userIdentifierstring
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    Description
    The user that caused the parked message metric
  - metricsParkedMessageMetricDetails[]
    Description
    The list of metric details
    - jurisdictionJurisdiction
      Description
      The jurisdiction
      x-extensible-enum: - CFTC - ESMA - ASIC - MAS - CA - FCA - ACER - SEC
    - messageTypeMessageType
      Description
      The message type
      x-extensible-enum: - TRANSACTION - PUBLIC - VALUATION - COLLATERAL - DISPUTE
    - deliveryMechanismDeliveryMechanism
      Description
      The delivery mechanism that upload was ingested
      x-extensible-enum: - API - UI - KOR_SFTP - CLIENT_SFTP - KOR_KAFKA
    - parkedTypeParkedType
      Description
      The type of the parked message, reflecting the reason why it was parked
      x-extensible-enum: - REHYDRATING_TRADE_STATE - PRIOR_UNRESOLVED_REJECTION - PRECEDING_TRADE_EVENT_PENDING - PRIOR_EVENT_AWAITING_UTI - DELAYED
    - valueinteger
      Example
      10
      Description
      The value of the metric

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

415Unsupported Media Type

500Internal Server Error

504Gateway Timeout

defaultInternal Server Error

curl

curl --request GET \
     --url 'https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics?jurisdiction=object&messageType=object&deliveryMechanism=object&parkedType=object' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics?jurisdiction=object&messageType=object&deliveryMechanism=object&parkedType=object", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics?jurisdiction=object&messageType=object&deliveryMechanism=object&parkedType=object")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://provisioning.rs.int.{environment}.korfinancial.com/parked-message-metrics?jurisdiction=object&messageType=object&deliveryMechanism=object&parkedType=object"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// The parked message metrics
{
  "cursor": "",
  "hasMore": false,
  "items": [
    {
      "timeInterval": "2024-01-27T12:00:00Z",
      "userIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
      "metrics": [
        {
          "jurisdiction": "",
          "messageType": "",
          "deliveryMechanism": "",
          "parkedType": "",
          "value": 10
        }
      ]
    }
  ]
}

400

// Bad Request

401

// Unauthorized

403

// Forbidden

404

// Not Found

405

// Method Not Allowed

406

// Not Acceptable

415

// Unsupported Media Type

500

// Internal Server Error

504

// Gateway Timeout

default

// Internal Server Error