Overview
This documentation outlines the REST APIs provided by the Process Mining platform. These APIs allow external systems to interact with process mining data, such as activity durations, resource involvement, costs, predictions, and process insights. The APIs can be integrated into automation platforms or analytics dashboards to retrieve real-time metrics from event logs. Process Mining Flow Steps are also available within the automation platform, which relies on these APIs to function.
Authentication
All API calls require a valid session ID in the form of a decisionsSessionDTO provided under the credentialsDTO field. Without valid credentials, the API will return authentication errors.
Activity APIs
/REST/Activity/GetActivityInsights
Fetches all insights for a specific activity in the event log. Useful for understanding the frequency, duration, and performance of an individual activity.
Method: POST
URL: http://{YourBasePortalURL}/REST/Activity/GetActivityInsights
Use Case: Analyze the performance of a specific step in your process to identify delays, repetitions, or inefficiencies.
/REST/Activity/GetActivityInsight
Fetches a specific insight for a given activity.
Method: POST
URL: http://{YourBasePortalURL}/REST/Activity/GetActivityInsight
/REST/Activity/GetActivitiesInsights
Retrieves all available insights for all activities within the event log. Ideal for bulk data analysis or dashboards.
/REST/Activity/GetActivitiesInsight
Retrieves a specific insight across all activities (e.g., min duration of all activities).
Activity Resource APIs
/REST/ActivityResource/GetActivityResourcesInvolvement
Returns all resources (people, bots, etc.) involved in a specified activity.
/REST/ActivityResource/GetActivitiesResourcesInvolvement
Returns resource involvement across all activities in the event log.
Cost APIs
/REST/Costs/GetCosts
Calculates total and per-case costs based on specified activities and resources with fixed and hourly rates.
Use Case
Estimate total cost of processes or compare the cost of different activities and resources to identify optimization areas.
/REST/Costs/GetCostTimestampAttributes
Lists timestamp fields usable in cost calculation.
/REST/Costs/GetCostResources
Lists all resources in the event log for cost attribution.
/REST/Costs/GetCostActivityAttributes
Lists all activity attributes that support costing.
/REST/Costs/GetCostActivities
Returns all activities available for cost analysis.
Process APIs
/REST/Process/GetProcessInsights
Retrieves all process-level insights from the event log.
/REST/Process/GetProcessInsight
Retrieves a specific process insight (e.g., total duration, throughput time).
Prediction APIs
/REST/Prediction/GeneratePredictiveModel
Trains a model from event log data.
/REST/Prediction/DeployPredictiveModel
Deploys a trained model.
/REST/Prediction/GetPrediction
Retrieves prediction results for a specific case.
/REST/Prediction/GetPredictions
Retrieves predictions for multiple cases.
/REST/Prediction/UndeployPredictiveModel
Removes a model from production.
These APIs can be used to embed AI-powered forecasting into process platform.