@uipath/uipath-typescript 1.3.10 → 1.3.11

package/dist/maestro-processes/index.mjs

@@ -77,6 +77,8 @@ const MAESTRO_ENDPOINTS = {
         TOP_PROCESSES_BY_RUN_COUNT: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/TopProcessesByRunCount`,
         /** Top processes ranked by failure count */
         TOP_PROCESSES_WITH_FAILURE: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/TopProcesseswithFailure`,
+        /** Top elements ranked by failure count */
+        TOP_ELEMENTS_WITH_FAILURE: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/TopElementswithFailure`,
         /** Instance status aggregated by date for time-series charts */
         INSTANCE_STATUS_BY_DATE: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/InstanceStatusByDate`,
         /** Top processes ranked by total duration */
@@ -2514,6 +2516,52 @@ class MaestroProcessesService extends BaseService {
         const { data } = await this.post(MAESTRO_ENDPOINTS.INSIGHTS.TOP_PROCESSES_BY_RUN_COUNT, buildInsightsTopBody(startTime, endTime, false, options));
         return (data ?? []).map(process => ({ ...process, name: process.packageId }));
     }
+    /**
+     * Get the top 10 BPMN elements ranked by failure count within a time range.
+     *
+     * Returns an array of up to 10 elements sorted by how many times they failed,
+     * useful for identifying the most error-prone activities in processes.
+     *
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param options - Optional filters (packageId, processKey, version)
+     * @returns Promise resolving to an array of {@link ElementGetTopFailedCountResponse}
+     * @example
+     * ```typescript
+     * import { MaestroProcesses } from '@uipath/uipath-typescript/maestro-processes';
+     *
+     * const maestroProcesses = new MaestroProcesses(sdk);
+     *
+     * // Get top failing elements for the last 7 days
+     * const topFailing = await maestroProcesses.getTopElementFailedCount(
+     *   new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
+     *   new Date()
+     * );
+     *
+     * for (const element of topFailing) {
+     *   console.log(`${element.elementName} (${element.elementType}): ${element.failedCount} failures`);
+     * }
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Get top failing elements for a specific process
+     * const filtered = await maestroProcesses.getTopElementFailedCount(
+     *   new Date(Date.now() - 7 * 24 * 60 * 60 * 1000),
+     *   new Date(),
+     *   { processKey: '<processKey>' }
+     * );
+     * ```
+     */
+    async getTopElementFailedCount(startTime, endTime, options) {
+        const { data } = await this.post(MAESTRO_ENDPOINTS.INSIGHTS.TOP_ELEMENTS_WITH_FAILURE, buildInsightsTopBody(startTime, endTime, false, options));
+        return (data ?? []).map(item => ({
+            elementName: item.elementName,
+            elementType: item.elementType,
+            processKey: item.processKey,
+            failedCount: item.count,
+        }));
+    }
     /**
      * Get all instances status counts aggregated by date for maestro processes.
      *
@@ -2654,6 +2702,9 @@ __decorate([
 __decorate([
     track('MaestroProcesses.GetTopRunCount')
 ], MaestroProcessesService.prototype, "getTopRunCount", null);
+__decorate([
+    track('MaestroProcesses.GetTopElementFailedCount')
+], MaestroProcessesService.prototype, "getTopElementFailedCount", null);
 __decorate([
     track('MaestroProcesses.GetInstanceStatusTimeline')
 ], MaestroProcessesService.prototype, "getInstanceStatusTimeline", null);