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

# Get aggregate job metrics

`GET /workflow_engine/jobs/metrics`

## Request

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

Searches aggregate job 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.
- `contains` string
- `containsField` 'workflow.name': Field to compare with contains value.

## Response `200`

metrics

- WorkflowEngineGetJobMetricsResponse200
  - `results` WorkflowEngineTaskMetricsDocument[]
    - `_id` string, required: String representation of a MongoDB ObjectId
    - `app` string, required
    - `name` string, required
    - `taskType` 'automatic' | 'manual' | 'operation', required
    - `global` boolean, required: Global designating if metric is global across automations or per-automation.
    - `taskId` string: Four character hexadecimal task identifier
    - `workflow` WorkflowEngineTaskMetricsDocumentWorkflow
      - `name` string
    - `metrics` WorkflowEngineTaskMetricsDocumentMetricsItems[], required: Aggregate job metrics collected on a weekly basis
      - `startDate` string, required: Metrics are collected on a weekly interval, starting at startDate.
      - `totalSuccesses` integer, required: Total number of tasks that ended in status success for the week starting at startDate.
      - `totalSuccessRunTime` integer, required: Total run time (milliseconds) for tasks that ended in status success for the week starting at startDate.
      - `totalErrors` integer, required: Total number of tasks that ended in status error for the week starting at startDate.
      - `totalErrorRunTime` integer, required: Total run time (milliseconds) for tasks that ended in status error for the week starting at startDate.
      - `totalFailures` integer, required: Total number of tasks that ended in status failure for the week starting at startDate.
      - `totalFailureRunTime` integer, required: Total run time (milliseconds) for tasks that ended in status failure for the week starting at startDate.
      - `slaTargetsMissed` integer: Total number of sla targets that were missed for a manual task for the week 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/jobs/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)