workflowEngine

Get aggregate job metrics

Searches aggregate job metrics with options.

get/workflow_engine/jobs/metrics

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/workflow_engine/jobs/metrics
  • Auth: none declared

Query parameters

order'-1' | '1'

The sort direction: 1 for ascending or -1 for descending.

order

sortstring

Field to sort by. Default is workflow.name.

sort

skipinteger

The number of documents skipped before returning data. When 0, no data is skipped.

skip

limitinteger

Specifies a limit to the maximum number of data results returned.

limit

greaterThanEqualsinteger

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

greaterThanEqualsField'metrics.startDate'

Date field to compare.

containsstring

String value to compare with containsField.

containsField'workflow.name'

Field to compare with contains value.

Response

metrics

skipinteger

The number of documents skipped before returning data. When 0, no data is skipped.

limitinteger

Specifies a limit to the maximum number of data results returned.

totalinteger

The total number of documents returned from a search.

Changes

No recorded changes to this operation across all 1 revision of this API.