Statistics
Access merge queue and CI performance statistics.
Time to merge statistics for every queue #
/repos/{owner}/{repository}/stats/time_to_merge
Get the average time to merge statistics, in seconds, for all the queues in the repository
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
at
string <date-time>
Retrieve the time to merge at this timestamp: 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.
branch
string
The name of the branch
200 Successful Response
Example Response
[
{
"queues": [
{}
]
}
]
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/time_to_merge" \
-H "Authorization: Bearer <token>"Get the queue checks outcome for the repository #
/repos/{owner}/{repository}/stats/merge_queue_checks_outcome
Statuses describing the state in which the pull requests have left the queue(s). Counted once per pull request a check carried: a batch of five pull requests yields five outcomes for one CI run. `ci_runs` counts CI runs once each, with how each ended.
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": {}
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/merge_queue_checks_outcome" \
-H "Authorization: Bearer <token>"Get the count of queue checks outcomes #
/repos/{owner}/{repository}/stats/queues_checks_outcome_count
Statuses describing the state in which the pull requests have left the queue(s), grouped by time intervals. Counted once per pull request a check carried: a batch of five pull requests yields five outcomes for one CI run. `ci_runs` counts CI runs once each, with how each ended.
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/queues_checks_outcome_count" \
-H "Authorization: Bearer <token>"Get the count of pull requests entering the queues #
/repos/{owner}/{repository}/stats/queues_entered_count
Queues pull requests entered by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/queues_entered_count" \
-H "Authorization: Bearer <token>"Get the count of pull requests merged by queues #
/repos/{owner}/{repository}/stats/queues_merged_count
Queues pull requests merged by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/queues_merged_count" \
-H "Authorization: Bearer <token>"Get the average CI runtime #
/repos/{owner}/{repository}/stats/average_ci_runtime
Runtime of your CI running on queued pull requests by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/average_ci_runtime" \
-H "Authorization: Bearer <token>"Get the idle queue time #
/repos/{owner}/{repository}/stats/idle_queue_time
Idle time spent in queue by the Pull Requests by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null,
"summary": {}
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/idle_queue_time" \
-H "Authorization: Bearer <token>"Get the queue time #
/repos/{owner}/{repository}/stats/total_queue_time
Total time spent in queue by the Pull Requests by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/total_queue_time" \
-H "Authorization: Bearer <token>"Get the queue size #
/repos/{owner}/{repository}/stats/queue_size
Get the average, max and min queue size over the period by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/queue_size" \
-H "Authorization: Bearer <token>"Get the number of running speculative checks #
/repos/{owner}/{repository}/stats/running_speculative_checks
Speculative checks running on queues by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/running_speculative_checks" \
-H "Authorization: Bearer <token>"Get the checks batch size #
/repos/{owner}/{repository}/stats/batch_size
Batch size of the checks running on queues by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/batch_size" \
-H "Authorization: Bearer <token>"Get batch bisection statistics #
/repos/{owner}/{repository}/stats/batch_bisection
Statistics about bisection events in the merge queue
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"started": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
],
"completed": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/batch_bisection" \
-H "Authorization: Bearer <token>"Get the base refs in the repository #
/repos/{owner}/{repository}/stats/branches
Retrieve a list of base refs branches affected by queue activity
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"base_refs": [
"string"
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/branches" \
-H "Authorization: Bearer <token>"Get the queue checks retries statistics #
/repos/{owner}/{repository}/stats/checks_retries
Statistics about checks retries in the merge queue by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/checks_retries" \
-H "Authorization: Bearer <token>"Get the CI runs the merge queues started, and how they ended #
/repos/{owner}/{repository}/stats/ci_runs
CI runs the merge queues started, the ones that succeeded, and the ones they tore down before a merge with the reason why, by intervals of time. A run is one check the queue started -- a draft pull request, or the queued pull request itself when it is checked in place -- counted once however many pull requests it carries. A run succeeded when at least one of its pull requests was not torn down after it: it passed, or a later run's result merged it. A run is counted as succeeded or wasted in the interval it ended in, so one still running is in neither. A run that passed and is torn down later, while it waited to merge, moves from succeeded in the interval it passed in to wasted in the one it was torn down in. A merge the queue trusts without running CI is not a run. Divide `started` by the merged pull requests of `queues_merged_count` for the CI runs each merge costs. A draft run carries pull requests of several priority rules, so there is no priority rule filter.
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"started": null,
"succeeded": null,
"wasted": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/ci_runs" \
-H "Authorization: Bearer <token>"Get the queue failure rate #
/repos/{owner}/{repository}/stats/failure_rate
Failure rate of pull requests in the merge queue by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/failure_rate" \
-H "Authorization: Bearer <token>"Get the batches merged by skip intermediate results #
/repos/{owner}/{repository}/stats/skip_intermediate_results
Batches merged as soon as a later batch carrying their changes passed (skip_intermediate_results), out of every batch the queue merged, and where each skip happened, by intervals of time
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/skip_intermediate_results" \
-H "Authorization: Bearer <token>"Get the batches skip intermediate results would have merged #
/repos/{owner}/{repository}/stats/skip_intermediate_results_eligibility
On a queue without skip_intermediate_results, the batches the option would have merged on a later batch's pass instead of waiting for their own checks, by intervals of time: how many there were, how long in total they went on waiting, in seconds, until their own checks ended or something else ended them, how many of those checks failed, making the batches tested on top of them run theirs again, and how many did not merge as they were. Each batch is counted in the interval its wait ended.
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/skip_intermediate_results_eligibility" \
-H "Authorization: Bearer <token>"Get PR exit reasons by interval #
/repos/{owner}/{repository}/stats/queues_pr_exit_reasons
Count of pull request queue-session exits by reason, grouped by time intervals. Each queue session (enter → leave) is counted once. A PR re-queued after failure appears in each session separately.
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
base_ref
string[]
Base reference(s) of the pull requests
queue_name
string[]
Name of the merge queue(s) for the pull requests
priority_rule_name
string[]
Name of the priority rule(s) of the pull requests
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"groups": [
{
"base_ref": "string",
"queue_name": "string",
"priority_rule_name": "string",
"stats": null
}
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/queues_pr_exit_reasons" \
-H "Authorization: Bearer <token>"Get the queue names in the repository #
/repos/{owner}/{repository}/stats/queues
Retrieve a list of queue names affected by queue activity
owner
string
required
The owner of the repository
min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$
repository
string
required
The name of the repository
min length: 1 · max length: 100 · pattern: ^[\w\-\.]+$
start_at
string <date-time>
Get the stats from this date: 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 1 day before `end_at`.
end_at
string <date-time>
Get the stats until this date: 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 now.
200 Successful Response
Example Response
{
"queue_names": [
"string"
]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/stats/queues" \
-H "Authorization: Bearer <token>"Was this page helpful?
Thanks for your feedback!