> ## Documentation Index
> Fetch the complete documentation index at: https://www.ravion.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# CI job metrics

> A finished job's CPU, memory, disk and network over time, with its step timeline, CPU percentiles and out-of-memory kills.



## OpenAPI

````yaml https://api.ravion.com/openapi.yaml get /ci/analytics/jobs/{stepExecutionId}/metrics
openapi: 3.0.0
info:
  title: Ravion
  version: 0.0.0
servers:
  - url: https://api.ravion.com
security:
  - BearerAuth: []
tags:
  - name: Projects
  - name: Environments
  - name: FeatureFlags
  - name: Pipelines
  - name: PipelineRuns
  - name: TerraformResources
  - name: TerraformExecutionSummaries
  - name: PipelineStepExecutions
  - name: AwsCloudWatch
  - name: AwsAmp
  - name: PipelineVersions
  - name: Organizations
  - name: Stacks
  - name: StackWorkspaces
  - name: Auth
  - name: OAuth
  - name: User
  - name: Health
  - name: Memberships
  - name: ServiceAccounts
  - name: Integrations
  - name: AwsDefaultNetworks
  - name: AwsAccounts
  - name: ApiKeys
  - name: EksPrometheus
  - name: EksLoki
  - name: ExecutionEnvironments
  - name: ModuleDefinitions
  - name: ModuleCategories
  - name: ModuleVersions
  - name: ModuleInstances
  - name: DefaultValueDefinitions
  - name: DefaultValues
  - name: CodeSources
  - name: Github
  - name: GitHub Actions
  - name: CI Analytics
  - name: Alerts
  - name: Gitlab
  - name: Slack
  - name: Git
  - name: MergeQueues
  - name: Values
  - name: Deployments
  - name: DeploymentResources
  - name: InfrastructureEvents
  - name: WebSocket
  - name: Domains
  - name: AcmCertificates
  - name: NotificationDestinations
  - name: NotificationDispatches
  - name: NotificationEvents
  - name: NotificationRules
  - name: Activity
  - name: Describe
  - name: Reports
  - name: Support
  - name: BillingPlans
  - name: BillingAccounts
  - name: BillingCycles
  - name: BillingUsageSummaries
  - name: BillingAddOns
  - name: BillingInvoices
  - name: Authorization
  - name: Sandboxes
  - name: SandboxCommands
  - name: SandboxPorts
  - name: Apps
paths:
  /ci/analytics/jobs/{stepExecutionId}/metrics:
    get:
      tags:
        - CI Analytics
      summary: CI job metrics
      description: >-
        A finished job's CPU, memory, disk and network over time, with its step
        timeline, CPU percentiles and out-of-memory kills. Returns 404 when the
        job is not in CI analytics or the caller cannot read its repository or
        pipeline, 503 when CI analytics are not configured.
      operationId: GetCIAnalyticsJobMetrics
      parameters:
        - description: >-
            The job's step execution ID, or a GitHub Actions job's GitHub job
            ID.
          in: path
          name: stepExecutionId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/CIAnalytics.JobMetrics'
                required:
                  - data
                type: object
          description: The request has succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: The request is invalid or malformed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: You are not authenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: You do not have permission to access this resource.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: The server cannot find the requested resource.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: Server error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: Service unavailable.
components:
  schemas:
    CIAnalytics.JobMetrics:
      additionalProperties: false
      description: One job's usage over time and its step timeline.
      properties:
        bookedCpu:
          format: double
          type: number
        bookedDiskGib:
          format: double
          type: number
        bookedMemoryGib:
          format: double
          type: number
        conclusion:
          $ref: '#/components/schemas/CIAnalytics.Conclusion'
        cpuPercentiles:
          allOf:
            - $ref: '#/components/schemas/CIAnalytics.JobMetricsCpuPercentiles'
          description: Absent when the job has no series.
        finishedAt:
          format: date-time
          type: string
        oomKills:
          description: >-
            Processes the kernel's out-of-memory killer ended in the job's VM.
            Absent when unknown.
          format: int64
          type: integer
        peakDiskMib:
          description: Absent when the host did not report usage.
          format: int64
          type: integer
        peakMemoryMib:
          description: Absent when the host did not report usage.
          format: int64
          type: integer
        peakVcpu:
          description: Absent when the host did not report usage.
          format: double
          type: number
        points:
          description: >-
            Oldest first. Empty for a job whose runner sent no series: sandbox
            hosts and EC2 runners that predate it, or an EC2 runner whose report
            did not arrive.
          items:
            $ref: '#/components/schemas/CIAnalytics.JobMetricsPoint'
          type: array
        samplesSource:
          allOf:
            - $ref: '#/components/schemas/CIAnalytics.JobMetricsSource'
          description: Absent when the job has no series.
        source:
          $ref: '#/components/schemas/CIAnalytics.Source'
        startedAt:
          format: date-time
          type: string
        stepExecutionId:
          type: string
        timeline:
          description: >-
            A GitHub Actions job's steps, or a pipeline step's phases and
            commands, oldest first.
          items:
            $ref: '#/components/schemas/CIAnalytics.JobMetricsTimelineEntry'
          type: array
      required:
        - stepExecutionId
        - source
        - conclusion
        - finishedAt
        - bookedCpu
        - bookedMemoryGib
        - bookedDiskGib
        - points
        - timeline
      type: object
    Errors.UserFacingErrorData:
      additionalProperties: false
      description: |-
        User-facing error presentation data.
        This is what the API returns to the frontend after formatting ErrorData
        using CEL templates from the error registry.

        Used for both:
        - Error fields on domain models (e.g., PipelineRun.error)
        - API error response bodies (HTTP 4xx/5xx responses)
      properties:
        action:
          allOf:
            - $ref: '#/components/schemas/Errors.Action'
          description: Optional action to help resolve the error
        code:
          description: Full error code, e.g., "Ravion:Pipeline:NOT_FOUND"
          type: string
        description:
          description: Additional description with more details
          type: string
        details:
          description: Structured details rendered as user-facing sections.
          items:
            $ref: '#/components/schemas/Errors.UserFacingErrorDetailSection'
          type: array
        isInternal:
          description: >-
            Indicates whether this error is internal (only set when
            ShowInternal=true).

            This allows Ravion staff to identify internal errors while viewing
            full details.
          type: boolean
        message:
          description: Main error message (required)
          type: string
        metadata:
          additionalProperties: {}
          description: >-
            Error params/metadata. Internal error details are visible only to
            Ravion staff.
          type: object
        requestId:
          description: Request ID for correlating errors with server logs.
          type: string
      required:
        - code
        - message
      type: object
    CIAnalytics.Conclusion:
      description: How a job ended.
      enum:
        - success
        - failure
        - cancelled
        - timed_out
        - skipped
      type: string
    CIAnalytics.JobMetricsCpuPercentiles:
      additionalProperties: false
      description: >-
        Percentiles of the series' vCPU busy, each point weighted by the time it
        covers.
      properties:
        p50:
          format: double
          type: number
        p75:
          format: double
          type: number
        p90:
          format: double
          type: number
        p95:
          format: double
          type: number
        p99:
          format: double
          type: number
      required:
        - p50
        - p75
        - p90
        - p95
        - p99
      type: object
    CIAnalytics.JobMetricsPoint:
      additionalProperties: false
      description: A job's usage at one instant.
      properties:
        at:
          description: The end of the stretch the point covers.
          format: date-time
          type: string
        cpuVcpu:
          description: vCPUs busy, on average, since the point before.
          format: double
          type: number
        diskMib:
          description: Disk in use, in MiB.
          format: int64
          type: integer
        memoryMib:
          description: The most memory in use since the point before, in MiB.
          format: int64
          type: integer
        netRxBytes:
          description: Bytes the job's VM received since the job began.
          format: int64
          type: integer
        netTxBytes:
          description: Bytes the job's VM sent since the job began.
          format: int64
          type: integer
      required:
        - at
        - cpuVcpu
        - memoryMib
        - diskMib
        - netRxBytes
        - netTxBytes
      type: object
    CIAnalytics.JobMetricsSource:
      description: Where a job's usage series was measured.
      enum:
        - guest
        - host
      type: string
    CIAnalytics.Source:
      description: >-
        Where a job ran from: a GitHub Actions job on a Ravion runner, or a
        pipeline step.
      enum:
        - github_actions
        - pipeline
      type: string
    CIAnalytics.JobMetricsTimelineEntry:
      additionalProperties: false
      description: A step, phase or command of the job, to lay its usage against.
      properties:
        conclusion:
          description: 'How it ended: GitHub''s step conclusion, or the runner''s status.'
          type: string
        exitCode:
          description: A command's exit code; absent for steps and phases.
          format: int32
          type: integer
        finishedAt:
          format: date-time
          type: string
        kind:
          $ref: '#/components/schemas/CIAnalytics.JobMetricsTimelineKind'
        name:
          type: string
        number:
          description: >-
            The GitHub step's number, which its logs are grouped by; absent for
            pipeline steps.
          format: int64
          type: integer
        startedAt:
          format: date-time
          type: string
      required:
        - kind
        - name
      type: object
    Errors.Action:
      additionalProperties: false
      description: Action to help user resolve the error
      properties:
        label:
          description: Button/link label text
          type: string
        url:
          description: URL to navigate to for resolution
          type: string
      required:
        - label
        - url
      type: object
    Errors.UserFacingErrorDetailSection:
      additionalProperties: false
      description: Structured user-facing error detail section.
      properties:
        items:
          description: List of detail values for this section.
          items:
            type: string
          type: array
        object:
          additionalProperties: {}
          description: Structured detail payload for object rendering.
          type: object
        render:
          description: Rendering hint for clients. Valid values are list or object.
          type: string
        title:
          description: Detail section title shown in the UI.
          type: string
      required:
        - title
        - render
      type: object
    CIAnalytics.JobMetricsTimelineKind:
      description: What a timeline entry is.
      enum:
        - step
        - phase
        - command
      type: string
  securitySchemes:
    BearerAuth:
      scheme: Bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.