Skip to content
Hayonix

API reference · Schema

ServerlessEndpointMetrics

  • objectstringrequired

    Always `serverless_endpoint_metrics`: the type of this object

    One ofserverless_endpoint_metrics

  • endpoint_idstringrequired

    ID of the endpoint

  • window_secondsintegerrequired

    Length of the window covered, in seconds, ending now

  • bucket_secondsintegerrequired

    Width of each bucket, in seconds

  • bucketsarray of objectrequired

    Buckets with any activity, oldest first (empty buckets are omitted)

    Show 14 fields of buckets
    • startstring (date-time)required

      Start of the bucket

    • submittedintegerrequired

      Jobs submitted in the bucket

    • succeededintegerrequired

      Jobs that finished as `succeeded` in the bucket

    • failedintegerrequired

      Jobs that finished as `failed` in the bucket

    • timed_outintegerrequired

      Jobs that finished as `timed_out` in the bucket

    • canceledintegerrequired

      Jobs that finished as `canceled` in the bucket

    • expiredintegerrequired

      Jobs that finished as `expired` in the bucket

    • retriedintegerrequired

      Retries (after lost workers) of the jobs that finished in the bucket

    • queue_delay_msobjectrequired

      For jobs that finished in the bucket: time from submission until a worker first took the job

      Show 3 fields of queue_delay_ms
      • avgnumber | nullrequired

        Mean, in milliseconds; null when no job counted

      • p50number | nullrequired

        Median (p50), in milliseconds; null when no job counted

      • p95number | nullrequired

        95th percentile (p95), in milliseconds; null when no job counted

    • execution_msobjectrequired

      For jobs that finished in the bucket: time their last attempt ran

      Show 3 fields of execution_ms
      • avgnumber | nullrequired

        Mean, in milliseconds; null when no job counted

      • p50number | nullrequired

        Median (p50), in milliseconds; null when no job counted

      • p95number | nullrequired

        95th percentile (p95), in milliseconds; null when no job counted

    • cold_startsintegerrequired

      New workers that became ready in the bucket

    • cold_start_msobjectrequired

      Cold start time of the workers that became ready in the bucket

      Show 2 fields of cold_start_ms
      • avgnumber | nullrequired

        Mean time from the worker being created until it was ready, in milliseconds; null when there was none

      • maxnumber | nullrequired

        Longest time from the worker being created until it was ready, in milliseconds; null when there was none

    • resumesintegerrequired

      Paused workers resumed (fast resume), counted when they took work again

    • resume_msobjectrequired

      Resume time of the workers counted in `resumes`

      Show 2 fields of resume_ms
      • avgnumber | nullrequired

        Mean time from the resume request until the worker was ready again, in milliseconds; null when there was none

      • maxnumber | nullrequired

        Longest time from the resume request until the worker was ready again, in milliseconds; null when there was none

Example
{
  "object": "serverless_endpoint_metrics",
  "endpoint_id": "string",
  "window_seconds": 1,
  "bucket_seconds": 1,
  "buckets": [
    {
      "start": "2026-01-01T00:00:00.000Z",
      "submitted": 1,
      "succeeded": 1,
      "failed": 1,
      "timed_out": 1,
      "canceled": 1,
      "expired": 1,
      "retried": 1,
      "queue_delay_ms": {
        "avg": 1.5,
        "p50": 1.5,
        "p95": 1.5
      },
      "execution_ms": {
        "avg": 1.5,
        "p50": 1.5,
        "p95": 1.5
      },
      "cold_starts": 1,
      "cold_start_ms": {
        "avg": 1.5,
        "max": 1.5
      },
      "resumes": 1,
      "resume_ms": {
        "avg": 1.5,
        "max": 1.5
      }
    }
  ]
}

Used by