Skip to main content

TaskMetricsResponse

Task metrics response - current performance statistics

byType object[]required

Per-task-type breakdown

  • Array [
  • avgDurationMsnumber<double>required

    Average duration in milliseconds

    Example: 2500
    avgQueueWaitMsnumber<double>required

    Average queue wait time in milliseconds

    Example: 150
    bytesProcessedinteger<int64>required

    Total bytes processed

    Possible values: >= 0

    Example: 1073741824
    errorRatePctnumber<double>required

    Error rate as percentage

    Example: 5
    executedinteger<int64>required

    Number of executions

    Possible values: >= 0

    Example: 100
    failedinteger<int64>required

    Failed executions

    Possible values: >= 0

    Example: 5
    itemsProcessedinteger<int64>required

    Total items processed

    Possible values: >= 0

    Example: 5000
    lastErrorstring | nullnullable

    Most recent error message

    lastErrorAtstring,null<date-time>nullable

    When the last error occurred

    maxDurationMsinteger<int64>required

    Maximum duration in milliseconds

    Possible values: >= 0

    Example: 15000
    minDurationMsinteger<int64>required

    Minimum duration in milliseconds

    Possible values: >= 0

    Example: 500
    p50DurationMsinteger<int64>required

    50th percentile (median) duration

    Possible values: >= 0

    Example: 2000
    p95DurationMsinteger<int64>required

    95th percentile duration

    Possible values: >= 0

    Example: 8000
    retriedinteger<int64>required

    Retried executions

    Possible values: >= 0

    Example: 10
    succeededinteger<int64>required

    Successful executions

    Possible values: >= 0

    Example: 95
    taskTypestringrequired

    Task type name

    Example: scan_library
    throughputPerSecnumber<double>required

    Throughput rate per second

    Example: 25.5
  • ]
  • queue objectrequired

    Queue health metrics

    oldestPendingAgeMsinteger,null<int64>nullable

    Age of oldest pending task in milliseconds

    Possible values: >= 0

    pendingCountinteger<int64>required

    Number of tasks waiting to run

    Possible values: >= 0

    Example: 25
    processingCountinteger<int64>required

    Number of tasks currently executing

    Possible values: >= 0

    Example: 4
    staleCountinteger<int64>required

    Number of stale/stuck tasks

    Possible values: >= 0

    Example: 0
    retentionstringrequired

    Current retention setting

    Example: 30
    summary objectrequired

    Overall summary statistics

    avgDurationMsnumber<double>required

    Average duration in milliseconds

    Example: 1500.5
    avgQueueWaitMsnumber<double>required

    Average queue wait time in milliseconds

    Example: 250
    tasksPerMinutenumber<double>required

    Tasks processed per minute (recent average)

    Example: 15.5
    totalExecutedinteger<int64>required

    Total tasks executed since last restart

    Possible values: >= 0

    Example: 1250
    totalFailedinteger<int64>required

    Total failed tasks

    Possible values: >= 0

    Example: 50
    totalSucceededinteger<int64>required

    Total successful tasks

    Possible values: >= 0

    Example: 1200
    updatedAtstring<date-time>required

    When the metrics were last updated

    Example: 2026-01-11T12:00:00Z
    TaskMetricsResponse
    {
    "byType": [
    {
    "avgDurationMs": 2500,
    "avgQueueWaitMs": 150,
    "bytesProcessed": 1073741824,
    "errorRatePct": 5,
    "executed": 100,
    "failed": 5,
    "itemsProcessed": 5000,
    "lastError": "string",
    "lastErrorAt": "2024-07-29T15:51:28.071Z",
    "maxDurationMs": 15000,
    "minDurationMs": 500,
    "p50DurationMs": 2000,
    "p95DurationMs": 8000,
    "retried": 10,
    "succeeded": 95,
    "taskType": "scan_library",
    "throughputPerSec": 25.5
    }
    ],
    "queue": {
    "oldestPendingAgeMs": 0,
    "pendingCount": 25,
    "processingCount": 4,
    "staleCount": 0
    },
    "retention": "30",
    "summary": {
    "avgDurationMs": 1500.5,
    "avgQueueWaitMs": 250,
    "tasksPerMinute": 15.5,
    "totalExecuted": 1250,
    "totalFailed": 50,
    "totalSucceeded": 1200
    },
    "updatedAt": "2026-01-11T12:00:00Z"
    }