Summary
Get aggregate task metrics
Description
Search aggregate task metrics with options
Route
GET /workflow_engine/tasks/metrics
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
Search options for aggregation |
Copied to Clipboard
{
"queryOptions": {
"order": 1,
"sort": "workflow.name",
"skip": 0,
"limit": 50,
"greaterThanEquals": 1617383798460,
"greaterThanEqualsField": "metrics.startDate",
"equals": "exampleName",
"equalsField": "workflow.name"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"order": {
"$ref": "wfEngineCommon#/definitions/order"
},
"sort": {
"$ref": "wfEngineCommon#/definitions/sort"
},
"skip": {
"$ref": "wfEngineCommon#/definitions/skip"
},
"limit": {
"$ref": "wfEngineCommon#/definitions/limit"
},
"greaterThanEquals": {
"type": "integer",
"description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.",
"examples": [
1617383798468,
1617383798460
]
},
"greaterThanEqualsField": {
"type": "string",
"description": "Date field to compare.",
"examples": [
"metrics.startDate"
],
"enum": [
"metrics.startDate"
]
},
"equals": {
"type": "string",
"description": "String value to compare with equalsField.",
"examples": [
"exampleName"
]
},
"equalsField": {
"type": "string",
"description": "Field to compare with equals value.",
"examples": [
"workflow.name"
],
"enum": [
"workflow.name"
]
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| metrics |
object |
- |
Copied to Clipboard
{
"results": [
{
"_id": "5cb7b531d06cceb89fd21b1c",
"workflow": {
"name": "exampleAutomationName",
"_id": "4321abcdef694aa79dae47ad"
},
"metrics": [
{
"jobsComplete": 40,
"totalRunTime": 200,
"totalManualTime": 700,
"slaTargetsMissed": 10,
"startDate": "2019-09-06T12:52:24.933Z"
},
{
"jobsComplete": 10,
"totalRunTime": 200,
"totalManualTime": 200,
"slaTargetsMissed": 10,
"startDate": "2019-09-06T12:52:24.933Z"
},
{
"jobsComplete": 40,
"totalRunTime": 200,
"totalManualTime": 200,
"slaTargetsMissed": 10,
"startDate": "2018-08-02T15:56:12.912Z"
},
{
"jobsComplete": 40,
"totalRunTime": 700,
"totalManualTime": 700,
"slaTargetsMissed": 10,
"startDate": "2019-09-06T12:52:24.933Z"
}
],
"preAutomationTime": 250000
}
],
"skip": 0,
"limit": 50,
"total": 100
}
