> ## 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.

# Sample a CI run

> The run at a percentile of run time, peak CPU or peak memory, with its steps. GET /ci/analytics/sample in the Ravion API reference.



## OpenAPI

````yaml https://api.ravion.com/openapi.yaml get /ci/analytics/sample
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/sample:
    get:
      tags:
        - CI Analytics
      summary: Sample a CI run
      description: >-
        The run at a percentile of run time, peak CPU or peak memory, with its
        steps. Returns 404 when no run in the range matches, 503 when CI
        analytics are not configured.
      operationId: GetCIAnalyticsSample
      parameters:
        - $ref: '#/components/parameters/CIAnalytics.Filters.from'
        - $ref: '#/components/parameters/CIAnalytics.Filters.to'
        - $ref: '#/components/parameters/CIAnalytics.Filters.executionEnvironmentId'
        - $ref: '#/components/parameters/CIAnalytics.Filters.codeSourceId'
        - $ref: '#/components/parameters/CIAnalytics.Filters.pipelineId'
        - $ref: '#/components/parameters/CIAnalytics.Filters.source'
        - $ref: '#/components/parameters/CIAnalytics.Filters.runnerSize'
        - $ref: '#/components/parameters/CIAnalytics.Filters.conclusion'
        - $ref: '#/components/parameters/CIAnalytics.Filters.scopeId'
        - $ref: '#/components/parameters/CIAnalytics.Filters.name'
        - in: query
          name: percentile
          required: true
          schema:
            $ref: '#/components/schemas/CIAnalytics.Percentile'
        - description: Defaults to duration.
          in: query
          name: metric
          schema:
            allOf:
              - $ref: '#/components/schemas/CIAnalytics.SampleMetric'
            nullable: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/CIAnalytics.Sample'
                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:
  parameters:
    CIAnalytics.Filters.from:
      description: First day of the range (UTC), inclusive.
      in: query
      name: from
      required: true
      schema:
        format: date
        type: string
    CIAnalytics.Filters.to:
      description: >-
        Last day of the range (UTC), inclusive. Must be on or after from; the
        range covers at most 400 days.
      in: query
      name: to
      required: true
      schema:
        format: date
        type: string
    CIAnalytics.Filters.executionEnvironmentId:
      description: Only jobs that ran in this execution environment.
      in: query
      name: executionEnvironmentId
      schema:
        nullable: true
        type: string
    CIAnalytics.Filters.codeSourceId:
      description: >-
        Only GitHub Actions jobs of this code source (repository). Returns 403
        when the caller cannot read it.
      in: query
      name: codeSourceId
      schema:
        nullable: true
        type: string
    CIAnalytics.Filters.pipelineId:
      description: Only steps of this pipeline. Returns 403 when the caller cannot read it.
      in: query
      name: pipelineId
      schema:
        nullable: true
        type: string
    CIAnalytics.Filters.source:
      description: Only jobs from this source.
      in: query
      name: source
      schema:
        allOf:
          - $ref: '#/components/schemas/CIAnalytics.Source'
        nullable: true
    CIAnalytics.Filters.runnerSize:
      description: >-
        Only jobs booked at this runner size, as Job.runnerSize labels it (for
        example "8 vCPU / 32 GiB").
      in: query
      name: runnerSize
      schema:
        nullable: true
        type: string
    CIAnalytics.Filters.conclusion:
      description: Only jobs that ended this way.
      in: query
      name: conclusion
      schema:
        allOf:
          - $ref: '#/components/schemas/CIAnalytics.Conclusion'
        nullable: true
    CIAnalytics.Filters.scopeId:
      description: >-
        With name (and source), only one workflow job or pipeline step: the code
        source ID for GitHub Actions jobs, the pipeline ID for pipeline steps.
      in: query
      name: scopeId
      schema:
        nullable: true
        type: string
    CIAnalytics.Filters.name:
      description: >-
        With scopeId, only the workflow job or pipeline step of this name, as
        Workload.name gives it.
      in: query
      name: name
      schema:
        nullable: true
        type: string
  schemas:
    CIAnalytics.Percentile:
      description: Which percentile run /ci/analytics/sample returns.
      enum:
        - p50
        - p90
        - p95
        - p99
        - max
      type: string
    CIAnalytics.SampleMetric:
      description: Which measure /ci/analytics/sample ranks runs by.
      enum:
        - duration
        - cpu
        - memory
      type: string
    CIAnalytics.Sample:
      additionalProperties: false
      description: The run at a percentile of a measure.
      properties:
        job:
          $ref: '#/components/schemas/CIAnalytics.Job'
        steps:
          items:
            $ref: '#/components/schemas/CIAnalytics.SampleStep'
          type: array
        value:
          description: 'The measure''s value for this run: milliseconds, vCPU or MiB.'
          format: double
          type: number
      required:
        - job
        - value
        - steps
      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.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.Conclusion:
      description: How a job ended.
      enum:
        - success
        - failure
        - cancelled
        - timed_out
        - skipped
      type: string
    CIAnalytics.Job:
      additionalProperties: false
      description: One job or pipeline step that ran on compute.
      properties:
        bookedCpu:
          format: double
          type: number
        bookedMemoryGib:
          format: double
          type: number
        branch:
          type: string
        conclusion:
          $ref: '#/components/schemas/CIAnalytics.Conclusion'
        finishedAt:
          format: date-time
          type: string
        ghJobId:
          description: GitHub job ID; absent for pipeline steps.
          type: string
        ghRunId:
          description: GitHub workflow run ID; absent for pipeline steps.
          type: string
        instanceType:
          type: string
        jobName:
          type: string
        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
        pipelineId:
          type: string
        pipelineRunId:
          type: string
        queueMs:
          format: int64
          type: integer
        queuedAt:
          format: date-time
          type: string
        repository:
          description: owner/name for GitHub Actions jobs; empty for pipeline steps.
          type: string
        runMs:
          format: int64
          type: integer
        runnerSize:
          description: >-
            "<vCPU> vCPU / <memory> GiB" as booked; for EC2 runners, the
            instance type's size.
          type: string
        sha:
          type: string
        source:
          $ref: '#/components/schemas/CIAnalytics.Source'
        startedAt:
          format: date-time
          type: string
        stepExecutionId:
          type: string
        stepId:
          type: string
        workflowName:
          type: string
      required:
        - stepExecutionId
        - source
        - repository
        - workflowName
        - jobName
        - pipelineId
        - pipelineRunId
        - stepId
        - conclusion
        - queuedAt
        - finishedAt
        - queueMs
        - runMs
        - bookedCpu
        - bookedMemoryGib
        - instanceType
        - runnerSize
        - branch
        - sha
      type: object
    CIAnalytics.SampleStep:
      additionalProperties: false
      description: >-
        A step of a sampled run: a GitHub Actions step, or a pipeline step's
        phase.
      properties:
        conclusion:
          type: string
        durationMs:
          format: int64
          type: integer
        finishedAt:
          format: date-time
          type: string
        name:
          type: string
        startedAt:
          format: date-time
          type: string
      required:
        - 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
  securitySchemes:
    BearerAuth:
      scheme: Bearer
      type: http

````

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