Get the execution metrics for the given Workflow ID

GET 
/workflow/:workflowId/metrics

Get the execution metrics for the given Workflow ID

Request

Path Parameters

workflowId stringrequired

Workflow string identifier

Query Parameters

workspaceId int64

Workspace numeric identifier

Responses

200

OK

application/json

Schema

Schema

metrics object[]
Array [
idint64nullable
processstringrequired
Possible values: <= 255 characters
cpu object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
mem object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
vmem object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
time object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
reads object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
writes object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
cpuUsage object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
memUsage object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
timeUsage object
warningsstring[]
meanfloat
minfloat
q1float
q2float
q3float
maxfloat
minLabelstring
maxLabelstring
q1Labelstring
q2Labelstring
q3Labelstring
]

Example (auto)

{
  "metrics": [
    {
      "id": 0,
      "process": "string",
      "cpu": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      },
      "mem": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      },
      "vmem": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      },
      "time": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      },
      "reads": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      },
      "writes": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      },
      "cpuUsage": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      },
      "memUsage": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      },
      "timeUsage": {
        "warnings": [
          "string"
        ],
        "mean": 0,
        "min": 0,
        "q1": 0,
        "q2": 0,
        "q3": 0,
        "max": 0,
        "minLabel": "string",
        "maxLabel": "string",
        "q1Label": "string",
        "q2Label": "string",
        "q3Label": "string"
      }
    }
  ]
}

400

Bad request

application/json

Schema

Schema

messagestringrequired

Example (auto)

{
  "message": "string"
}

403

Operation not allowed

Authorization: http

name: BearerAuthtype: httpscheme: bearerbearerFormat: jwt

• python
• curl
• java
• r
• javascript
• go
• powershell

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("docs.seqera.io")
payload = ''
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("GET", "/workflow/:workflowId/metrics", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Auth

Bearer Token

Parameters

workflowId — pathrequired

workspaceId — query