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 job metrics

GET
http://localhost:3000/workflow_engine/jobs/metrics
GET
/workflow_engine/jobs/metrics
$curl http://localhost:3000/workflow_engine/jobs/metrics \
>     -u "<username>:<password>"
1{
2  "results": [
3    {
4      "_id": "4321abcdef694aa79dae47ad",
5      "app": "WorkflowBuilder",
6      "name": "getTime",
7      "taskType": "automatic",
8      "global": true,
9      "metrics": [
10        {
11          "startDate": "2018-08-02T15:56:12.912Z",
12          "totalSuccesses": 5,
13          "totalSuccessRunTime": 550,
14          "totalErrors": 5,
15          "totalErrorRunTime": 550,
16          "totalFailures": 5,
17          "totalFailureRunTime": 550,
18          "slaTargetsMissed": 5
19        }
20      ],
21      "taskId": "12ab",
22      "workflow": {
23        "name": "exampleAutomationName"
24      }
25    }
26  ],
27  "skip": 0,
28  "limit": 50,
29  "total": 100
30}
Searches aggregate job metrics with options.
Was this page helpful?
Previous

Get aggregate task metrics

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:
containsstringOptional
String value to compare with containsField.
containsFieldenumOptional
Field to compare with contains 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