WarpBuild LogoWarpBuild Docs
Org metrics

GET /org_metrics/job_runner_recommendations

Returns, for every GitHub job in the organization's last 7 days that should move to a different runner size, a right-sizing recommendation (derived from the job's aggregate CPU/memory usage across all its runs) plus a sample of its most recent runs.

GET
/org_metrics/job_runner_recommendations

Authorization

JWTKeyAuth
Authorization<token>

In: header

Query Parameters

search?string

Text search across repository, workflow name, and job name

repo_workflows?array<string>

Repository/workflow pairs to filter by, each formatted as repository and workflow name joined by a newline

page?integer

Page number, 1-based (default 1)

per_page?integer

Results per page (default 50, max 200)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.warpbuild.com/api/v1/org_metrics/job_runner_recommendations"
{
  "available_filters": {
    "repos": [
      {
        "repository": "string",
        "workflows": [
          "string"
        ]
      }
    ]
  },
  "next": 0,
  "organization_id": "string",
  "page": 0,
  "per_page": 0,
  "recommendations": [
    {
      "job_name": "string",
      "recommendation": {
        "already_at_max_size": true,
        "current_label": "string",
        "current_memory_gb": 0,
        "current_vcpu": 0,
        "recommended_label": "string",
        "recommended_memory_gb": 0,
        "recommended_vcpu": 0,
        "resources": [
          "string"
        ],
        "type": "string"
      },
      "repository": "string",
      "runs": [
        {
          "avg_filesystem_utilization": 0,
          "ended_at": "string",
          "head_sha": "string",
          "job_link": "string",
          "max_filesystem_utilization": 0,
          "max_memory_utilization": 0,
          "max_sustained_cpu": 0,
          "max_sustained_disk_io_bytes": 0,
          "max_sustained_network_bytes": 0,
          "runner_display_name": "string",
          "runner_instance_id": "string",
          "started_at": "string"
        }
      ],
      "total_runs": 0,
      "workflow_name": "string",
      "workflow_url": "string"
    }
  ],
  "total_pages": 0,
  "total_rows": 0
}
{
  "code": "string",
  "description": "string",
  "message": "string",
  "sub_code": "string",
  "sub_message": "string"
}
{
  "code": "string",
  "description": "string",
  "message": "string",
  "sub_code": "string",
  "sub_message": "string"
}
{
  "code": "string",
  "description": "string",
  "message": "string",
  "sub_code": "string",
  "sub_message": "string"
}