Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferenceComputeRunners

Get runner job metrics and cost comparison

Returns a runner pool's daily job counts, totals, average queue and queued-to-completed times over 30 days, and the GitHub-hosted cost of its completed jobs. The GitHub estimate covers completed jobs, per started minute of run time. savedCents is that estimate minus the pool's monthly price, never below zero.

Required permission

Requires the runner.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl runners job-metrics get <id>
GET
/v1/orgs/{orgId}/runner-pools/{id}/metrics

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string
id*string

Response Body

OK

application/json
  1. response
daily*array<>
summary*
cost*
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/runner-pools/string/metrics'
Example Response
{  "daily": [    {      "date": "string",      "completed": 0,      "failed": 0,      "cancelled": 0,      "running": 0    }  ],  "summary": {    "totalJobs": 0,    "completedJobs": 0,    "failedJobs": 0,    "avgDurationSec": 0,    "avgQueueTimeSec": 0  },  "cost": {    "githubCostCents": 0,    "vectorlayCostCents": 0,    "savedCents": 0  }}