Stash Integration Point
Overview
The Stash Progress Summary IP provides detailed insights into the progress of items in a stash used during an integration exchange. It allows users monitor processing progress and identify items that have been processed recently or have encountered errors. This is especially useful for monitoring the health and status of the integration process, enabling quick action when issues arise.
Endpoint
GET
http://[hostName]:[portNumber]/[api-context-root]/stashes/<exchange_id>/progressDescription
Returns a summary of the progress for a specific stash used during an integration exchange. This includes:
-
stash name
-
total items in the stash
-
processed count and the percentage of items processed
-
recently processed items (items processed within the last minute) and the percentage of these items relative to the total
-
errored items and the percentage of errored items
Response
The response is a list of stash progress objects. Each object contains information about one stash.
Response Structure
[
{
"stashName": "string", // Name of the stash (e.g., "email", "members")
"totalItems": integer, // Total number of items in the stash
"processed": integer, // Total number of items processed
"processedPercent": float, // Percentage of items processed
"recentlyProcessed": integer, // Number of items processed within the last minute
"recentlyProcessedPercent": float, // Percentage of items processed recently
"errored": integer, // Number of errored items
"erroredPercent": float // Percentage of errored items
}
]
Sample Response
[
{
"stashName": "email",
"totalItems": 6000,
"processed": 3000,
"processedPercent": 50,
"recentlyProcessed": 500,
"recentlyProcessedPercent": 8.3,
"errored": 1500,
"erroredPercent": 25
},
{
"stashName": "members",
"totalItems": 4000,
"processed": 4000,
"processedPercent": 100,
"recentlyProcessed": 200,
"recentlyProcessedPercent": 5,
"errored": 0,
"erroredPercent": 0
}
]