Integration Monitoring API Use Cases

The following use cases illustrate the business scenarios where the Integration monitoring API can be used:

Get the Status Based on Integration Event Name

Customers can use the API to retrieve the status of a specified integration event, by passing the event name in the request.

Get the Status Summary for Historical Event Runs

Customers can use the API to retrieve the event run status history for a specified file channel event and a specified count of historical runs. Specifying the count of historical runs retrieves the status summary for a number of runs equal to this value, counting backward from the most recent run. For example, if the count is specified as 20, the API retrieves the last 20 runs of the event.

Get the Detailed Status of Any Integrtion Event That Ran in the Past Using Its Unique Identifier Key (`uid`)

Customers can use the API to retrieve the detailed status of any integration event that ran in the past, by sending its unique identifier key (uid) in the request.

Integration Monitoring API Use Cases

Get the Status Based on Integration Event Name

Get the Status Summary for Historical Event Runs

Get the Detailed Status of Any Integrtion Event That Ran in the Past Using Its Unique Identifier Key (uid)

Get the Detailed Status of Any Integrtion Event That Ran in the Past Using Its Unique Identifier Key (`uid`)