---
title: "Process Mining APIs"
slug: "process-mining-apis-1"
updated: 2025-12-19T21:56:48Z
published: 2025-12-19T21:56:48Z
canonical: "documentation.decisions.com/process-mining-apis-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.decisions.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Process Mining APIs

## 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.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/image-1760392211660.png)

---

### 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](/step-library/docs/get-activity-insights)

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](/step-library/docs/get-activity-insight)

Fetches a specific insight for a given activity.

**Method:** POST

**URL:** `http://{YourBasePortalURL}/REST/Activity/GetActivityInsight`

### [/REST/Activity/GetActivitiesInsights](/step-library/docs/get-activities-insights)

Retrieves all available insights for all activities within the event log. Ideal for bulk data analysis or dashboards.

### [/REST/Activity/GetActivitiesInsight](/step-library/docs/get-activities-insight)

Retrieves a specific insight across all activities (e.g., min duration of all activities).

---

## Activity Resource APIs

### [/REST/ActivityResource/GetActivityResourcesInvolvement](/step-library/docs/get-activity-resources-involvement)

Returns all resources (people, bots, etc.) involved in a specified activity.

### [/REST/ActivityResource/GetActivitiesResourcesInvolvement](/step-library/docs/get-activities-resources-involvement)

Returns resource involvement across all activities in the event log.

---

## Cost APIs

### [/REST/Costs/GetCosts](/step-library/docs/get-costs)

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](/step-library/docs/get-cost-timestamp-attributes)

Lists timestamp fields usable in cost calculation.

### [/REST/Costs/GetCostResources](/step-library/docs/get-cost-resources)

Lists all resources in the event log for cost attribution.

### [/REST/Costs/GetCostActivityAttributes](/step-library/docs/get-cost-activity-attributes)

Lists all activity attributes that support costing.

### /REST/Costs/GetCostActivities

Returns all activities available for cost analysis.

---

## Process APIs

### [/REST/Process/GetProcessInsights](/step-library/docs/get-process-insights)

Retrieves all process-level insights from the event log.

### [/REST/Process/GetProcessInsight](/step-library/docs/get-process-insight)

Retrieves a specific process insight (e.g., total duration, throughput time).

---

## Prediction APIs

### [/REST/Prediction/GeneratePredictiveModel](/step-library/docs/generate-predictive-model)

Trains a model from event log data.

### [/REST/Prediction/DeployPredictiveModel](/step-library/docs/deploy-predictive-model)

Deploys a trained model.

### [/REST/Prediction/GetPrediction](/step-library/docs/get-prediction)

Retrieves prediction results for a specific case.

### [/REST/Prediction/GetPredictions](/step-library/docs/get-predictions)

Retrieves predictions for multiple cases.

### [/REST/Prediction/UndeployPredictiveModel](/step-library/docs/undeploy-predictive-model)

Removes a model from production.

These APIs can be used to embed AI-powered forecasting into process platform.

---