CI Insights

Access data from CI Insights.

Get a single runner stat as a time series #

GET /ci/{owner}/runners/stats/{stat}

Return one of the runner stats bucketed over the requested time range, with a summary value over the full window.

Authorization (any one of)

Admin Application Key MergifyTokenBearerAuth GitHub Token

Path Parameters

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

Query Parameters

runner_name string[]

The runner name to filter on

runner_name_exclude string[]

The runner name to exclude

runner_group_name string[]

The runner group name to filter on

runner_group_name_exclude string[]

The runner group name to exclude

runner_labels string[]

The runner labels to filter on (all must match)

start string <date-time>

Start of the time range: an ISO 8601 datetime with a UTC offset (e.g. `2024-01-01T00:00:00Z`); a Unix timestamp or a datetime without an offset is refused. Defaults to `end - 1 day` when omitted; a paginated response carries the resolved value in its `Link` header.

end string <date-time>

End of the time range: an ISO 8601 datetime with a UTC offset (e.g. `2024-01-01T00:00:00Z`); a Unix timestamp or a datetime without an offset is refused. Defaults to `start + 1 day` when only start is provided, or `now` otherwise; a paginated response carries the resolved value in its `Link` header.

Responses

200 Successful Response

Discriminated by stat — 12 types

avg_durationRunnerDurationStatsResponse

valueinteger | nullrequired

value_over_time_RunnerStatsBucket_int_[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

Enum: avg_duration min_duration median_duration p95_duration p99_duration max_duration

min_durationRunnerDurationStatsResponse

valueinteger | nullrequired

value_over_time_RunnerStatsBucket_int_[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

Enum: avg_duration min_duration median_duration p95_duration p99_duration max_duration

median_durationRunnerDurationStatsResponse

valueinteger | nullrequired

value_over_time_RunnerStatsBucket_int_[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

Enum: avg_duration min_duration median_duration p95_duration p99_duration max_duration

p95_durationRunnerDurationStatsResponse

valueinteger | nullrequired

value_over_time_RunnerStatsBucket_int_[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

Enum: avg_duration min_duration median_duration p95_duration p99_duration max_duration

p99_durationRunnerDurationStatsResponse

valueinteger | nullrequired

value_over_time_RunnerStatsBucket_int_[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

Enum: avg_duration min_duration median_duration p95_duration p99_duration max_duration

max_durationRunnerDurationStatsResponse

valueinteger | nullrequired

value_over_time_RunnerStatsBucket_int_[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

Enum: avg_duration min_duration median_duration p95_duration p99_duration max_duration

success_rateRunnerRateStatsResponse

valuenumber | nullrequired

value_over_time_RunnerStatsBucket_float_[]required

startstring <date-time>required

endstring <date-time>required

valuenumber | nullrequired

stat"success_rate" | "jobs_per_hour" | "avg_jobs_per_hour" | "utilization_rate"required

Enum: success_rate jobs_per_hour avg_jobs_per_hour utilization_rate

jobs_per_hourRunnerRateStatsResponse

valuenumber | nullrequired

value_over_time_RunnerStatsBucket_float_[]required

startstring <date-time>required

endstring <date-time>required

valuenumber | nullrequired

stat"success_rate" | "jobs_per_hour" | "avg_jobs_per_hour" | "utilization_rate"required

Enum: success_rate jobs_per_hour avg_jobs_per_hour utilization_rate

avg_jobs_per_hourRunnerRateStatsResponse

valuenumber | nullrequired

value_over_time_RunnerStatsBucket_float_[]required

startstring <date-time>required

endstring <date-time>required

valuenumber | nullrequired

stat"success_rate" | "jobs_per_hour" | "avg_jobs_per_hour" | "utilization_rate"required

Enum: success_rate jobs_per_hour avg_jobs_per_hour utilization_rate

utilization_rateRunnerRateStatsResponse

valuenumber | nullrequired

value_over_time_RunnerStatsBucket_float_[]required

startstring <date-time>required

endstring <date-time>required

valuenumber | nullrequired

stat"success_rate" | "jobs_per_hour" | "avg_jobs_per_hour" | "utilization_rate"required

Enum: success_rate jobs_per_hour avg_jobs_per_hour utilization_rate

active_runnersRunnerCountStatsResponse

valueinteger | nullrequired

value_over_time_RunnerStatsBucket_int_[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

stat"active_runners" | "active_jobs"required

Enum: active_runners active_jobs

active_jobsRunnerCountStatsResponse

valueinteger | nullrequired

value_over_time_RunnerStatsBucket_int_[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

stat"active_runners" | "active_jobs"required

Enum: active_runners active_jobs

Example Response

                          {
  "value": 0,
  "value_over_time": [
    {
      "start": "2024-01-15T09:00:00Z",
      "end": "2024-01-15T09:00:00Z",
      "value": 0
    }
  ],
  "stat": "avg_duration"
}

403 `CI_ADMIN_ROLE_REQUIRED`: Only organization admins and users with the CI Admin role can access this.

detailstringrequired

Enum: CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_NAME_TAKEN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_FOUND PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED RETRY_RULE_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RETRY_NOT_CONFIGURED TEST_STATE_OVERLAP

documentation_urlstring

Example Response

                          {
  "detail": "string",
  "error_code": "CI_ADMIN_ROLE_REQUIRED",
  "documentation_url": "string"
}

404 Not found

409 Conflict

422 Unprocessable entity

Example Request

curl -X GET "https://api.mergify.com/v1/ci/:owner/runners/stats/:stat" \
  -H "Authorization: Bearer <token>"

Get a single CI queue stat as a time series #

GET /ci/{owner}/queue/stats/{stat}

Return one of the CI queue stats bucketed over the requested time range, with a summary value over the full window.

Authorization (any one of)

Admin Application Key MergifyTokenBearerAuth GitHub Token

Path Parameters

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

Query Parameters

labels string[]

The labels to filter on (all must match)

start string <date-time>

end string <date-time>

Responses

200 Successful Response

Enum: total_jobs avg_wait_time min_wait_time median_wait_time p95_wait_time p99_wait_time max_wait_time

valueinteger | nullrequired

value_over_time_QueueStatsBucket[]required

startstring <date-time>required

endstring <date-time>required

valueinteger | nullrequired

Example Response

                          {
  "stat": "total_jobs",
  "value": 0,
  "value_over_time": [
    {
      "start": "2024-01-15T09:00:00Z",
      "end": "2024-01-15T09:00:00Z",
      "value": 0
    }
  ]
}

403 `CI_ADMIN_ROLE_REQUIRED`: Only organization admins and users with the CI Admin role can access this.

detailstringrequired

documentation_urlstring

Example Response

                          {
  "detail": "string",
  "error_code": "CI_ADMIN_ROLE_REQUIRED",
  "documentation_url": "string"
}

404 Not found

409 Conflict

422 Unprocessable entity

Example Request

curl -X GET "https://api.mergify.com/v1/ci/:owner/queue/stats/:stat" \
  -H "Authorization: Bearer <token>"

Tell what happened to a repository's latest test result uploads #

GET /ci/{owner}/repositories/{repository}/traces-status

The uploads waiting or being processed, how many of them were tried again, and the last upload refused in the past 24 hours because none of its test results could be stored.

Authorization (any one of)

Admin Application Key MergifyTokenBearerAuth GitHub Token

Path Parameters

repository string required

The name of the repository

min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$

owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

Responses

200 Successful Response

pendingPendingUploadsrequired

waitingintegerrequired

Uploads received and waiting to be processed.

processingintegerrequired

Uploads being processed right now.

retriedintegerrequired

Uploads tried again after an attempt that did not finish, counted in waiting or processing too.

oldest_waiting_received_atstring <date-time> | nullrequired

When the oldest waiting upload was received. Null when none is waiting.

last_refusedRefusedUpload | nullrequired

The last upload refused because none of its test results could be stored, within the last 24 hours. Null when there is none.

refused_atstring <date-time>required

When the upload was refused.

job_namestring | nullrequired

The job that sent it, as the upload names it. Null when it names none.

reasonsstring[]required

What was wrong with its resource attributes, one message each.

Example Response

                          {
  "pending": {
    "waiting": 0,
    "processing": 0,
    "retried": 0,
    "oldest_waiting_received_at": "2024-01-15T09:00:00Z"
  },
  "last_refused": {
    "refused_at": "2024-01-15T09:00:00Z",
    "job_name": "string",
    "reasons": [
      "string"
    ]
  }
}

403 Forbidden

404 Not found

409 Conflict

422 Unprocessable entity

Example Request

curl -X GET "https://api.mergify.com/v1/ci/:owner/repositories/:repository/traces-status" \
  -H "Authorization: Bearer <token>"

Was this page helpful?