---
title: "Get aggregate task metrics"
method: GET
path: "/workflow_engine/tasks/metrics"
tags: ["Workflow Engine"]
---

# Get aggregate task metrics

`GET /workflow_engine/tasks/metrics`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/workflow_engine/tasks/metrics`
- Auth: none declared

Searches aggregate task metrics with options.

## Query parameters

- `order` '-1' | '1': The sort direction: 1 for ascending or -1 for descending.
- `sort` string: Field to sort by. Default is workflow.name.
- `skip` integer: The number of documents skipped before returning data. When 0, no data is skipped.
- `limit` integer: Specifies a limit to the maximum number of data results returned.
- `greaterThanEquals` integer
- `greaterThanEqualsField` 'metrics.startDate': Date field to compare.
- `equals` string
- `equalsField` 'workflow.name': Field to compare with equals value.

## Response `200`

metrics

- WorkflowEngineGetTaskMetricsResponse200
  - `results` WorkflowEngineJobMetricsDocument[]
    - `_id` string, required: String representation of a MongoDB ObjectId
    - `workflow` WorkflowEngineJobMetricsDocumentWorkflow, required
      - `name` string
      - `_id` string
    - `preAutomationTime` integer: Time (milliseconds) automation would have taken someone to complete without using IAP.
    - `metrics` WorkflowEngineJobMetricsDocumentMetricsItems[], required: Aggregate job metrics collected on a weekly basis
      - `jobsComplete` integer, required: Total number of jobs complete for automation for the week starting at startDate.
      - `totalRunTime` integer, required: Total run time (milliseconds) of jobs complete for automation for the week starting at startDate.
      - `totalManualTime` integer, required: Total time (milliseconds) spent working manual a task for automation for the week starting at startDate.
      - `slaTargetsMissed` integer, required: Total number of sla targets that were missed for an automation for the week starting at startDate.
      - `startDate` string, required: Metrics are collected on a weekly interval, starting at startDate
  - `skip` integer: The number of documents skipped before returning data. When 0, no data is skipped.
  - `limit` integer: Specifies a limit to the maximum number of data results returned.
  - `total` integer: The total number of documents returned from a search.

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Workflow Engine` added
  - api tag `workflowEngine` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/workflow_engine/tasks/metrics/get.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)