For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTActivate task worker
        • POSTActivate the job worker
        • GETCheck staterator state
        • POSTCreate task mock
        • POSTDeactivate task worker
        • POSTDeactivate the job worker
        • DELDelete a task mock
        • POSTdiff to HTML
        • POSTEvaluation
        • POSTEvaluation group
        • GETGet aggregate job metrics
        • GETGet aggregate task metrics
        • GETGet task mock
        • GETGet the current task rate limit settings
        • GETGet worker status
        • POSTQuery data using 'json-query' format
        • PUTReplace a task mock
        • GETReturn a list of all IANA defined timezones
        • GETSearch task mocks
        • PUTUpdate the task rate limit settings at runtime
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceWorkflow Engine

Get aggregate task metrics

GET
http://localhost:3000/workflow_engine/tasks/metrics
GET
/workflow_engine/tasks/metrics
$curl http://localhost:3000/workflow_engine/tasks/metrics \
>     -u "<username>:<password>"
1{
2  "results": [
3    {
4      "_id": "4321abcdef694aa79dae47ad",
5      "workflow": {
6        "name": "exampleAutomationName",
7        "_id": "4321abcdef694aa79dae47ad"
8      },
9      "metrics": [
10        {
11          "jobsComplete": 10,
12          "totalRunTime": 200,
13          "totalManualTime": 200,
14          "slaTargetsMissed": 5,
15          "startDate": "2018-08-02T15:56:12.912Z"
16        }
17      ],
18      "preAutomationTime": 5000
19    }
20  ],
21  "skip": 0,
22  "limit": 50,
23  "total": 100
24}
Searches aggregate task metrics with options.
Was this page helpful?
Previous

Get task mock

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

orderenumOptionalDefaults to 1
order
Allowed values:
sortstringOptionalDefaults to workflow.name
sort
skipintegerOptional>=0
skip
limitintegerOptional0-100
limit
greaterThanEqualsintegerOptional

Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.

greaterThanEqualsFieldenumOptional
Date field to compare.
Allowed values:
equalsstringOptional
String value to compare with equalsField.
equalsFieldenumOptional
Field to compare with equals value.
Allowed values:

Response

metrics
resultslist of objects
skipinteger>=0
The number of documents skipped before returning data. When 0, no data is skipped.
limitinteger0-100
Specifies a limit to the maximum number of data results returned.
totalinteger>=0
The total number of documents returned from a search.

Errors

500
Internal Server Error