Activity Log

Retrieve and aggregate the timeline of Mergify events for a repository.


Get the activity log #

GET /repos/{owner}/{repository}/logs

Get the activity log of the requested repository. Supports filtering by event_type, derived outcome (success / failure / pending / neutral), trigger (include only these trigger strings — Datadog Only), and not_trigger (exclude). trigger and not_trigger are mutually exclusive.

Application key permission: activity_log: read.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
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\-]+$

pull_request integer[]

Filter events by pull-request number: an event matches when it belongs to any of the given pull requests, as its pull_request or as one of the several an event about a batch belongs to. Repeatable to match several PRs at once (e.g. ?pull_request=1&pull_request=2).

base_ref string

Get events for PRs to the given base ref

min length: 1 · max length: 255

batch_pull integer[]

Filter to batch (draft) pull requests' own lifecycle events by number (surfaced in the dashboard as "Batch Pull Request"). Repeatable to match several batches at once. The draft PR is the Mergify-opened pull request that speculatively checks a batch; this returns each batch's action.queue.checks_start / action.queue.checks_end events (which snapshot the draft PR number), the queue.batch_run_start / queue.batch_run_end events of the runs those belong to, and the batch's bisection events. When in_place is true the number is the user's own PR rather than a Mergify draft. The number rotates on checks-retry — each event snapshots the number at that attempt. Mutually exclusive with not_batch_pull (exclusion).

not_batch_pull integer[]

Exclude batch (draft) pull requests' own lifecycle events by number — the same event set batch_pull includes, negated. Repeatable. Mirrors Datadog's facet semantics: unchecking a batch pull request in the dashboard sidebar adds it to the exclusion list. Mutually exclusive with batch_pull (positive include).

event_type ("action.assign" | "action.backport" | "action.close" | "action.comment" | "action.copy" | "action.delete_head_branch" | "action.dequeue" | "action.dismiss_reviews" | "action.edit" | "action.github_actions" | "action.label" | "action.label.loop_stopped" | "action.merge" | "action.post_check" | "action.queue.batch_bisection_end" | "action.queue.batch_bisection_start" | "action.queue.batch_composition" | "action.queue.change" | "action.queue.checks.change" | "action.queue.checks_end" | "action.queue.checks_postponed" | "action.queue.checks_start" | "action.queue.conflict_deferred" | "action.queue.enter" | "action.queue.leave" | "action.queue.merged" | "action.rebase" | "action.refresh" | "action.request_reviews" | "action.review" | "action.squash" | "action.update" | "ci_insights.auto_quarantine.disabled" | "ci_insights.auto_quarantine.enabled" | "ci_insights.auto_quarantine.modified" | "ci_insights.job_retried" | "command.dequeue" | "command.queue" | "conflict_resolution.attempt" | "product.disabled" | "product.enabled" | "queue.batch_run_end" | "queue.batch_run_start" | "queue.pause.create" | "queue.pause.delete" | "queue.pause.update" | "scheduled_freeze.create" | "scheduled_freeze.delete" | "scheduled_freeze.update" | "test.health.changed" | "test.state.added" | "test.state.removed" | "test_retry.disabled" | "test_retry.enabled" | "test_retry.modified")[]

The specific types of events to select. action.queue.checks_not_started is accepted as a deprecated alias of action.queue.checks_postponed. test.quarantined and test.dequarantined are deprecated and will be removed: use test.state.added and test.state.removed. Until then they select the events of those types whose metadata.state is quarantined, returned under those types.

not_event_type ("action.assign" | "action.backport" | "action.close" | "action.comment" | "action.copy" | "action.delete_head_branch" | "action.dequeue" | "action.dismiss_reviews" | "action.edit" | "action.github_actions" | "action.label" | "action.label.loop_stopped" | "action.merge" | "action.post_check" | "action.queue.batch_bisection_end" | "action.queue.batch_bisection_start" | "action.queue.batch_composition" | "action.queue.change" | "action.queue.checks.change" | "action.queue.checks_end" | "action.queue.checks_postponed" | "action.queue.checks_start" | "action.queue.conflict_deferred" | "action.queue.enter" | "action.queue.leave" | "action.queue.merged" | "action.rebase" | "action.refresh" | "action.request_reviews" | "action.review" | "action.squash" | "action.update" | "ci_insights.auto_quarantine.disabled" | "ci_insights.auto_quarantine.enabled" | "ci_insights.auto_quarantine.modified" | "ci_insights.job_retried" | "command.dequeue" | "command.queue" | "conflict_resolution.attempt" | "product.disabled" | "product.enabled" | "queue.batch_run_end" | "queue.batch_run_start" | "queue.pause.create" | "queue.pause.delete" | "queue.pause.update" | "scheduled_freeze.create" | "scheduled_freeze.delete" | "scheduled_freeze.update" | "test.health.changed" | "test.state.added" | "test.state.removed" | "test_retry.disabled" | "test_retry.enabled" | "test_retry.modified")[]

Exclude events whose type matches any of the given values. Mutually exclusive with event_type (positive include). action.queue.checks_not_started is accepted as a deprecated alias of action.queue.checks_postponed. test.quarantined and test.dequarantined are deprecated and will be removed: use test.state.added and test.state.removed. Until then they select the events of those types whose metadata.state is quarantined, returned under those types.

outcome ("success" | "failure" | "pending" | "neutral")[]

Filter events by derived outcome label (success / failure / pending / neutral). Repeatable to match several outcomes at once (e.g. ?outcome=success&outcome=failure).

not_outcome ("success" | "failure" | "pending" | "neutral")[]

Exclude events whose derived outcome label matches any of the given values (success / failure / pending / neutral). Repeatable. Mirrors Datadog's facet semantics: unchecking an outcome in the dashboard sidebar adds it to the exclusion list. Mutually exclusive with outcome (positive include).

trigger string[]

Include only events whose trigger matches one of the given values (exact match). Repeatable. Mirrors Datadog's facet behaviour after clicking Only: the URL switches from exclusion mode to inclusion mode with a positive list — shorter than not_trigger=<everything else>. Mutually exclusive with not_trigger.

not_trigger string[]

Exclude events whose trigger matches any of the given values (exact match). Repeatable. Mirrors Datadog's facet semantics: the default state is all triggers included, and unchecking a trigger in the dashboard sidebar adds it to the exclusion list. Mutually exclusive with trigger (positive include).

not_pull_request integer[]

Exclude events that belong to any of the given pull requests, the way pull_request matches them. Mutually exclusive with pull_request (positive include).

received_from 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 received_to - 1 day.

received_to 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 now.

cursor string

The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages

per_page integer

The number of items per page

min: 1 · max: 100

200 Successful Response
sizeintegerrequired

The number of items in this page

per_pageintegerrequired

The number of items per page

eventsobject (55 types)[]required

The list of events

Discriminated by type — 55 types
action.assignEventAssign
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventAssignMetadatarequired
addedstring[]required
removedstring[]required
action.backportEventBackport
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCopyMetadatarequired
tostringrequired
pull_request_numberintegerrequired
conflictsbooleanrequired
action.closeEventClose
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCloseMetadatarequired
messagestringrequired
action.commentEventComment
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCommentMetadatarequired
messagestringrequired
action.copyEventCopy
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCopyMetadatarequired
tostringrequired
pull_request_numberintegerrequired
conflictsbooleanrequired
action.delete_head_branchEventDeleteHeadBranch
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventDeleteHeadBranchMetadatarequired
branchstringrequired
action.dequeueEventDequeue
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
metadataEventNoMetadatarequired
typestringrequired
action.dismiss_reviewsEventDismissReviews
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventDismissReviewsMetadatarequired
usersstring[]required
action.editEventEdit
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventEditMetadatarequired
draftbooleanrequired
action.github_actionsEventGithubActions
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventGithubActionsMetadatarequired
workflowstringrequired
inputsobjectrequired
action.labelEventLabel
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventLabelMetadatarequired
addedstring[]required
removedstring[]required
action.label.loop_stoppedEventLabelLoopStopped
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventLabelLoopStoppedMetadatarequired
labelstringrequired

The label Mergify stopped adding and removing on the pull request.

rulesstring[]required

The pull request rules that kept adding and removing the label, undoing each other.

action.mergeEventMerge
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventMergeMetadatarequired
branchstringrequired
action.post_checkEventPostCheck
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventPostCheckMetadatarequired
conclusion"success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | nullrequired
titlestringrequired
summarystringrequired
action.queue.batch_bisection_endEventQueueBatchBisectionEnd
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueBatchBisectionEndMetadatarequired
queue_namestringrequired
priority_rule_namestring | nullrequired
original_batch_pr_numbersinteger[]required
culprit_foundbooleanrequired
culprit_pr_numbersinteger[]required
confirmed_culprit_pr_numbersinteger[] | nullrequired
dropped_unverified_pr_numbersinteger[] | nullrequired
remaining_pr_numbersinteger[]required
max_failure_resolution_reachedbooleanrequired
session_idstring <uuid>required
batch_idstring <uuid> | nullrequired

The batch this event concerns. Correlate the queue events for a batch (checks_start / checks_end / leave / bisection) on this id. Null on events persisted before this field was added.

train_car_idstring <uuid> | nullrequired

Deprecated: use batch_id instead (same value).

batch_namestring | nullrequired

The display name of the batch this event concerns, the same name the merge queue shows while the batch is queued. Recorded on the event because the name lives only in the live queue state and is unrecoverable once the batch leaves the queue. Null on events persisted before this field was added.

action.queue.batch_bisection_startEventQueueBatchBisectionStart
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueBatchBisectionStartMetadatarequired
queue_namestringrequired
priority_rule_namestring | nullrequired
original_batch_pr_numbersinteger[]required
batch_size_before_splitintegerrequired
number_of_sub_batchesintegerrequired
bisection_depthintegerrequired
is_top_levelbooleanrequired
session_idstring <uuid>required
batch_idstring <uuid> | nullrequired

The batch this event concerns. Correlate the queue events for a batch (checks_start / checks_end / leave / bisection) on this id. Null on events persisted before this field was added.

train_car_idstring <uuid> | nullrequired

Deprecated: use batch_id instead (same value).

batch_namestring | nullrequired

The display name of the batch this event concerns, the same name the merge queue shows while the batch is queued. Recorded on the event because the name lives only in the live queue state and is unrecoverable once the batch leaves the queue. Null on events persisted before this field was added.

action.queue.batch_compositionEventQueueBatchComposition
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueBatchCompositionMetadatarequired
queue_namestringrequired
batch_idstring <uuid>required

The batch composed. A batch composed again -- a retried build, a speculative batch re-merging its parents, a bisection child -- emits one event per attempt, each with its own head_sha.

batch_namestring | nullrequired

The display name of the batch this event concerns, the same name the merge queue shows while the batch is queued. Recorded on the event because the name lives only in the live queue state and is unrecoverable once the batch leaves the queue. Null on events persisted before this field was added.

head_shastring | nullrequired

The head of the batch branch this attempt composed, which holds one merge commit per pull request -- where each resolution can be seen. Null when the composition stopped on a conflict, and there is no branch.

pull_request_numbersinteger[]required

The pull requests the batch branch is composed of, in order -- including those of the batches ahead it is built on, which a speculative batch merges again, and so reports again: own_pull_request_numbers tells them apart. Not all of them were necessarily merged: one the base already contains is skipped, and a composition that stops on a conflict never reaches those after it.

own_pull_request_numbersinteger[]required

The pull requests queued in this batch, without those of the batches ahead it merges again.

merge_commitsEventQueueBatchCompositionMergeCommit[]required

The merge commit each pull request made on the batch branch, in the order composed. Empty when the composition stopped on a conflict, as nothing was pushed. A pull request the base already contains is not merged, and has none.

pull_request_numberintegerrequired

The pull request this commit merged into the batch.

min: 1 · max: 9223372036854776000
shastringrequired

The merge commit, on the batch branch. Its diff against its first parent is what merging the pull request wrote, each path's resolution included.

status"clean" | "conflict"required

clean when every pull request merged into the batch branch. conflict when one did not, and the composition stopped there.

Enum: clean conflict
conflicting_pull_request_numberinteger | nullrequired

The pull request whose merge stopped the composition, after the pull requests before it in pull_request_numbers. Null when the composition is clean, and on events persisted before this field was added.

conflicting_pathsEventQueueBatchCompositionConflictingPath[] | nullrequired

Every path of the batch's merges that conflicted, or that automatic conflict resolution settled, sorted by path. A path covered by ours, theirs or union is listed wherever both sides changed it, conflicting or not: those strategies act whether the changes overlap or not, and do not record which. A path settled in more than one of the batch's merges is listed once per outcome. Null on events persisted before this field was added.

pathstringrequired

The path, relative to the repository root.

resolverPreview"union" | "ours" | "theirs" | "prefer-ours" | "prefer-theirs" | "json" | "pnpm" | "uv" | "rails-schema" | "yarn" | "typescript" | "rails-structure" | "rust" | "python" | "yaml" | "cargo" | "npm" | "go" | "gomod" | "sbt" | "terraform" | "nix" | "ruby" | "swift" | "mix" | "hcl" | "haskell" | "java" | "csharp" | "kotlin" | "php" | "c" | "toml" | "css" | "pip" | "dockerfile" | "xml" | "nuget" | "gradle" | "composer" | "astro" | "markdown" | "manual" | "text" | nullrequired

The strategy from the repository's conflict_resolvers that applies to this path, as written in the configuration or as an auto entry picked it (see auto). Null when none applies: no entry covers the path, a text entry leaves it to git's line merge, or the queue's merge method does not use automatic conflict resolution.

outcome"resolved" | "unresolved"required

What came of the path. resolved: the resolver settled it, the way its strategy says. unresolved: the path still conflicts, which is what stopped the composition.

Enum: resolved unresolved
autoPreviewboolean

Whether an auto entry of conflict_resolvers picked resolver for this path, rather than an entry naming it. Absent from events recorded before this field existed.

left_becausePreview"no_strategy" | "not_read" | "declined"

Why an unresolved path was left, where resolver does not say it. no_strategy: no strategy is handed its conflict. not_read: its strategy could not read it. declined: its strategy left it conflicting.

Enum: no_strategy not_read declined
pull_request_numbersPreviewinteger[]

For a resolved path, the pull requests whose merge into the batch the strategy merged it in, lowest number first, up to 100. On a composition a conflict stopped, the pull request whose merge conflicted is among them for the paths its merge did merge, although that merge never reached the batch. Absent from events recorded before this field existed.

action.queue.changeEventQueueChange
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueChangeMetadatarequired
queue_namestringrequired
priority_rule_namestring | nullrequired
sizeintegerrequired
action.queue.checks.changeEventQueueChecksChange
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueChecksChangeMetadatarequired
queue_namestringrequired
running_checksintegerrequired
action.queue.checks_endEventQueueChecksEnd
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueChecksEndApiMetadatarequired
abortedbooleanrequired
abort_code"PR_DEQUEUED" | "PR_DEQUEUED_FROM_PARTITION" | "PR_AHEAD_DEQUEUED" | "BATCH_AHEAD_FAILED" | "PR_WITH_HIGHER_PRIORITY_QUEUED" | "SCHEDULED_FREEZE_STATUS_CHANGED" | "SPECULATIVE_CHECK_NUMBER_REDUCED" | "CHECKS_TIMEOUT" | "CHECKS_FAILED" | "DROPPED_BY_BISECTION_ELIMINATION" | "QUEUE_RULE_MISSING" | "BASE_BRANCH_MISSING" | "BASE_BRANCH_CHANGED" | "PR_UNEXPECTEDLY_FAILED_TO_MERGE" | "BATCH_MAX_FAILURE_RESOLUTION_ATTEMPTS" | "PR_CHECKS_STOPPED_BECAUSE_MERGE_QUEUE_PAUSE" | "CONFLICT_WITH_BASE_BRANCH" | "CONFLICT_WITH_PULL_AHEAD" | "BRANCH_UPDATE_FAILED" | "DRAFT_PULL_REQUEST_CHANGED" | "BATCH_PULL_REQUEST_CLOSED" | "PULL_REQUEST_UPDATED" | "MERGE_QUEUE_RESET" | "INCOMPATIBILITY_WITH_BRANCH_PROTECTIONS" | "PR_MANUALLY_MERGED" | "DRAFT_PULL_REQUEST_CREATION_FAILED" | "DRAFT_PULL_REQUEST_CREATION_BRANCH_NOT_INDEXED" | "CONFIGURATION_CHANGED" | "UNPROCESSABLE_PULL_REQUEST" | "PR_MANUALLY_DEQUEUED" | "STACK_PREDECESSOR_DEQUEUED" | "INTERMEDIATE_RESULTS_SKIPPED" | "CHECKS_RETRIED" | "SCHEDULE_BLOCKED_AHEAD_YIELDED" | "BASE_REF_ALIGNMENT_TIMEOUT" | "GITHUB_STACKED_PULL_REQUEST_MERGE_UNSUPPORTED" | "BATCH_SCOPES_CHANGED" | "BATCH_AHEAD_BRANCH_EDITED" | "CHECKS_INTERRUPTED" | "GITHUB_WORKFLOWS_PERMISSION_MISSING" | "BATCH_REBUILT" | "BATCH_AHEAD_REBUILT" | "GITHUB_REBASE_MERGE_REFUSED" | "PR_IN_SAME_BATCH_DEQUEUED" | nullrequired
abort_reasonstring | nullrequired

Why the checks were aborted, as markdown: the names it quotes, such as a check, a partition or the reason the merge queue was paused, are code spans. A reason an older release recorded, or one this release can no longer read or render, may be served as the plain text it was recorded with. Null when the checks did not abort.

abort_status"DEFINITIVE" | "REEMBARKED"required
Enum: DEFINITIVE REEMBARKED
branchstringrequired
priority_rule_namestring | nullrequired
queue_namestringrequired
queued_atstring <date-time>required
retry_attemptinteger | nullrequired
max_retriesinteger | nullrequired
retries_before_runinteger | null

How many checks retries preceded this run: 0 for a first attempt, 1 or more for a rerun after a failure (whose duration is a repeat attempt, not a nominal run). Distinct from retry_attempt, which concerns the retry abort event. Null on events persisted before this field existed.

bisection_depthinteger | null

How many splits of a failing batch this batch descends from: 0 for a batch checked as it was embarked, 1 or more for a sub-batch created while bisecting a failing batch (its run checks a reduced batch). Null on events persisted before this field existed.

speculative_check_pull_requestSignals_SpeculativeCheckPullRequestrequired
numberinteger | nullrequired

The number of the pull request the checks of this run ran on: the draft pull request, or the pull request itself when it is checked in place. Null when the merge queue checked the batch on its merge queue branch without opening a draft pull request: head_sha and queue_branch_name name the run then.

head_shastring | nullrequired

The commit the checks of this run ran on: the head of the draft pull request or of the merge queue branch, or of the pull request itself when it is checked in place. Null on events persisted before this field existed.

queue_branch_namestring | nullrequired

The merge queue branch the checks of this run ran on. Null when the pull request is checked in place, and on events persisted before this field existed.

in_placebooleanrequired
checks_timed_outbooleanrequired
checks_conclusion"success" | "failure" | "neutral" | "cancelled" | "skipped" | "stale" | "action_required" | "timed_out" | "error" | "pending"required
Enum: success failure neutral cancelled skipped stale action_required timed_out error pending
checks_started_atstring <date-time> | nullrequired
checks_ended_atstring <date-time> | nullrequired

When the checks of this run ended: when the checks named by its merge conditions, and by its queue conditions too for a run on the queued pull request itself, reported the results that decided them. A passed and is decided by the last of its branches, a passed or by the first; a failed one the other way round. A run that no check report dates ends when Mergify found it ended: one that timed out, one whose conditions count, match a pattern of, or exclude checks rather than name them, one that an or passed on a branch naming no check beside one naming a check, and one whose checks passed while a schedule or a freeze still held its conditions. Never before the run started, and never after checks_end_detected_at. On events persisted before checks_end_detected_at existed, it is when Mergify found the run ended.

checks_end_delivered_atstring <date-time> | nullrequired

When the check results that decided this run had reached Mergify, decided as checks_ended_at is. After checks_ended_at when the results took time to be delivered. A result Mergify read from GitHub before processing the webhook GitHub sent for it counts as delivered when it was read, even if the webhook arrived earlier. Null when no check report dates the run, when Mergify does not know when one of those results reached it (it arrived before Mergify recorded that, its record is gone, or the check was completed again since), and on events persisted before this field existed.

checks_end_detected_atstring <date-time> | nullrequired

When Mergify found the checks of this run ended. After checks_end_delivered_at when Mergify took time to act on the results it had received. Null on events persisted before this field existed.

unsuccessful_checksQueueCheck_Serialized[]required
pull_request_numbersinteger[]required
direct_merge_impacted_base_scopesstring[] | nullrequired

The scopes the base branch moved in while this pull request was queued, when the merge skipped its queue CI run and trusted the pull request's own checks because none of those commits touch what it touches. Null when a check ran, when the pull request already contained the base tip and so had nothing to re-check, and on events persisted before this field existed.

batch_idstring <uuid> | nullrequired

The batch this event concerns. Correlate the queue events for a batch (checks_start / checks_end / leave / bisection) on this id. Null on events persisted before this field was added.

train_car_idstring <uuid> | nullrequired

Deprecated: use batch_id instead (same value).

batch_namestring | nullrequired

The display name of the batch this event concerns, the same name the merge queue shows while the batch is queued. Recorded on the event because the name lives only in the live queue state and is unrecoverable once the batch leaves the queue. Null on events persisted before this field was added.

run_idstring <uuid> | null

The CI run this event belongs to. The checks_start of a run and every checks_end of it carry the same id, and each run gets a new one: a batch's checks run again when they are retried, when the batch is split to isolate a failing pull request, or when the pull request checked in place is updated. Null on events of a run that started before this field was added.

scopesstring[] | nullrequired

The scopes of the batch checking this pull request. Batches with disjoint scopes run their checks concurrently, so the scope tells which parallel lane the batch occupies. Empty when the queue is not scoped. Null on events persisted before this field was added.

parent_batch_idsstring <uuid>[] | nullrequired

The batch ids this batch was queued behind, as of this event. A batch inherits its parents' check results, so this links it back to the ones checked before it. A parent may be dropped once its pull requests have merged, so a later event for the same batch can list fewer parents than an earlier one, or none at all. Empty on a first check with no predecessor. Null on events persisted before this field was added.

session_idstring <uuid>required
all_scopesboolean | null

Whether the batch checking this pull request impacts every scope (a merge-queue barrier). Null on events persisted before this field existed.

rescued_test_countinteger | nullrequired

How many tests failed, then passed when test retry ran them again, in checks that passed, counted from the test results Mergify has received so far. Results can arrive after the checks end, so the count can appear or change later. Null when the checks did not pass, when their run was stopped, when the merge queue reused the pull request's own checks, or when no test passed only on a retry.

action.queue.checks_postponedEventQueueChecksPostponed
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueChecksPostponedMetadatarequired
branchstringrequired
priority_rule_namestring | nullrequired
queue_namestringrequired
queued_atstring <date-time>required
reasonstringrequired
session_idstring <uuid>required
batch_idstring <uuid> | nullrequired

The sub-batch this event concerns. Correlate the checks_postponed events emitted for one failed sub-batch on this id. Null on events persisted before this field was added.

batch_namestring | nullrequired

The display name of the batch this event concerns, the same name the merge queue shows while the batch is queued. Recorded on the event because the name lives only in the live queue state and is unrecoverable once the batch leaves the queue. Null on events persisted before this field was added.

sub_batch_pr_numbersinteger[] | nullrequired

The pull request numbers of the whole failed sub-batch, so a collapsed row can name every affected pull request and not just the one this per-pull-request event carries. Null on events persisted before this field was added.

attemptinteger | null

1-based number of this draft-creation failure within the pull request's current queue stay (metadata.session_id): 1 on the first failure, incrementing on each automatic retry. Authoritative — it reflects every stored failure of the stay, independent of the requested time window or page, so a repeatedly-stuck pull request reads its true count. Null/absent on events that predate this field or when the count could not be derived.

action.queue.checks_startEventQueueChecksStart
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueChecksStartMetadatarequired
branchstringrequired
priority_rule_namestring | nullrequired
queue_namestringrequired
queued_atstring <date-time>required
start_reasonstringrequired

Why the checks started, as markdown. A restart quotes the reason the previous checks were aborted, where the names it quotes, such as a partition or the reason the merge queue was paused, are code spans. One an older release recorded, or one quoting a reason this release can no longer read or render, may quote it as plain text.

speculative_check_pull_requestSignals_SpeculativeCheckPullRequestrequired
numberinteger | nullrequired

The number of the pull request the checks of this run ran on: the draft pull request, or the pull request itself when it is checked in place. Null when the merge queue checked the batch on its merge queue branch without opening a draft pull request: head_sha and queue_branch_name name the run then.

head_shastring | nullrequired

The commit the checks of this run ran on: the head of the draft pull request or of the merge queue branch, or of the pull request itself when it is checked in place. Null on events persisted before this field existed.

queue_branch_namestring | nullrequired

The merge queue branch the checks of this run ran on. Null when the pull request is checked in place, and on events persisted before this field existed.

in_placebooleanrequired
checks_timed_outbooleanrequired
checks_conclusion"success" | "failure" | "neutral" | "cancelled" | "skipped" | "stale" | "action_required" | "timed_out" | "error" | "pending"required
Enum: success failure neutral cancelled skipped stale action_required timed_out error pending
checks_started_atstring <date-time> | nullrequired
checks_ended_atstring <date-time> | nullrequired

When the checks of this run ended: when the checks named by its merge conditions, and by its queue conditions too for a run on the queued pull request itself, reported the results that decided them. A passed and is decided by the last of its branches, a passed or by the first; a failed one the other way round. A run that no check report dates ends when Mergify found it ended: one that timed out, one whose conditions count, match a pattern of, or exclude checks rather than name them, one that an or passed on a branch naming no check beside one naming a check, and one whose checks passed while a schedule or a freeze still held its conditions. Never before the run started, and never after checks_end_detected_at. On events persisted before checks_end_detected_at existed, it is when Mergify found the run ended.

checks_end_delivered_atstring <date-time> | nullrequired

When the check results that decided this run had reached Mergify, decided as checks_ended_at is. After checks_ended_at when the results took time to be delivered. A result Mergify read from GitHub before processing the webhook GitHub sent for it counts as delivered when it was read, even if the webhook arrived earlier. Null when no check report dates the run, when Mergify does not know when one of those results reached it (it arrived before Mergify recorded that, its record is gone, or the check was completed again since), and on events persisted before this field existed.

checks_end_detected_atstring <date-time> | nullrequired

When Mergify found the checks of this run ended. After checks_end_delivered_at when Mergify took time to act on the results it had received. Null on events persisted before this field existed.

unsuccessful_checksQueueCheck_Serialized[]required
pull_request_numbersinteger[]required
direct_merge_impacted_base_scopesstring[] | nullrequired

The scopes the base branch moved in while this pull request was queued, when the merge skipped its queue CI run and trusted the pull request's own checks because none of those commits touch what it touches. Null when a check ran, when the pull request already contained the base tip and so had nothing to re-check, and on events persisted before this field existed.

batch_idstring <uuid> | nullrequired

The batch this event concerns. Correlate the queue events for a batch (checks_start / checks_end / leave / bisection) on this id. Null on events persisted before this field was added.

train_car_idstring <uuid> | nullrequired

Deprecated: use batch_id instead (same value).

batch_namestring | nullrequired

The display name of the batch this event concerns, the same name the merge queue shows while the batch is queued. Recorded on the event because the name lives only in the live queue state and is unrecoverable once the batch leaves the queue. Null on events persisted before this field was added.

run_idstring <uuid> | null

The CI run this event belongs to. The checks_start of a run and every checks_end of it carry the same id, and each run gets a new one: a batch's checks run again when they are retried, when the batch is split to isolate a failing pull request, or when the pull request checked in place is updated. Null on events of a run that started before this field was added.

scopesstring[] | nullrequired

The scopes of the batch checking this pull request. Batches with disjoint scopes run their checks concurrently, so the scope tells which parallel lane the batch occupies. Empty when the queue is not scoped. Null on events persisted before this field was added.

parent_batch_idsstring <uuid>[] | nullrequired

The batch ids this batch was queued behind, as of this event. A batch inherits its parents' check results, so this links it back to the ones checked before it. A parent may be dropped once its pull requests have merged, so a later event for the same batch can list fewer parents than an earlier one, or none at all. Empty on a first check with no predecessor. Null on events persisted before this field was added.

previous_batch_idstring <uuid> | nullrequired

The ID of the batch checked just before this one for the same pull request, when this check is a restart. Null on the first check.

previous_batch_namestring | nullrequired

The display name of previous_batch_id's batch, read back from that batch's own checks_end event. Null on the first check, and when the predecessor was checked before batch_name was recorded on events.

session_idstring <uuid>required
all_scopesboolean | null

Whether the batch checking this pull request impacts every scope (a merge-queue barrier). Null on events persisted before this field existed.

action.queue.conflict_deferredEventQueueConflictDeferred
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueConflictDeferredMetadatarequired
branchstringrequired
priority_rule_namestring | nullrequired
queue_namestringrequired
queued_atstring <date-time>required
reasonstringrequired

Why the pull request is held back, as markdown: the file paths it quotes are code spans. A reason an older release recorded, or one this release can no longer read or render, may be served as the plain text it was recorded with.

session_idstring <uuid>required
blocking_pull_request_numbersinteger[]required

The pull requests ahead in the queue the pull request is held behind, in flight when the merge failed. reason names those of them that change a file the merge stopped on, and claims a conflict with at least one of them, or says that none of them changes one and the conflict is with the base branch.

conflicting_filesConflictingFiles | nullrequired

The files the merge stopped on, merging the pull request after every one ahead of it, the first of them by path in listed and how many there are in count. With several conflicting pull requests, each conflicts on some of them, not necessarily all. Null when the deferral recorded none.

listedConflictingFile[]required
countintegerrequired
conflict_resolution_advicePreviewstring | nullrequired

What automatic conflict resolution could do about this conflict, as the markdown paragraph reason ends with. Null when there is nothing to advise.

conflicts_with_no_pull_request_aheadboolean | nullrequired

Whether none of the pull requests in blocking_pull_request_numbers changes a file the merge stopped on. The conflict is then with branch, so their leaving the queue does not resolve it: only an update of the pull request with branch does. Null when the event does not tell: one recorded before the queue told this case apart, or one whose reason this release can no longer read.

conflicting_pull_request_numbersinteger[] | nullrequired

Those of blocking_pull_request_numbers the conflict is with, the ones reason names: each changes a file the merge stopped on, or its changes could not be read whole. Empty when conflicts_with_no_pull_request_ahead is true. Null when the event does not tell, as for conflicts_with_no_pull_request_ahead: reason then names every one of blocking_pull_request_numbers.

blocking_pull_requestsPullRequestReference[]

The pull requests of metadata.blocking_pull_request_numbers the engine holds a record of, in the same order, each with its title, author and current state. A number with no record (a pull request the engine never stored, or one since deleted by retention) is left out.

numberintegerrequired
min: 1 · max: 9223372036854776000
titlestringrequired
html_urlstringrequired
authorPullRequestReferenceAuthorrequired
idintegerrequired
loginstringrequired
avatar_urlstring | nullrequired

The account's avatar URL. Null when it is not known.

state"open" | "closed"required

Its state now, as the engine last recorded it, which need not be the one it had when the event was recorded.

Enum: open closed
mergedbooleanrequired
action.queue.enterEventQueueEnter
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueEnterMetadatarequired
queue_namestringrequired
branchstringrequired
queued_atstring <date-time>required
priority_rule_namestring | nullrequired
session_idstring <uuid>required
action.queue.leaveEventQueueLeave
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueLeaveMetadatarequired
reasonstringrequired

Why the pull request left the queue, as markdown: the names it quotes, such as a branch or a check, are code spans. A reason recorded by a release this one can no longer read or render is served as the plain text it was recorded with.

mergedbooleanrequired
queue_namestringrequired
branchstringrequired
queued_atstring <date-time>required
seconds_waiting_for_scheduleintegerrequired
seconds_waiting_for_freezeintegerrequired
priority_rule_namestring | nullrequired
conditions_evaluationQueueConditionEvaluationResult_Serialized | nullrequired

The merge conditions as the batch last evaluated them, or null when the pull request left before they were. A condition's match holds for the whole batch: true when every pull request meets the condition and, under a not, when any does. What each pull request read is in the condition's evaluations.

matchbooleanrequired
labelstringrequired
is_label_user_inputbooleanrequired
descriptionstring | nullrequired
attribute_namestring | nullrequired
operatorstring | nullrequired
scheduleobject | nullrequired
subconditionsQueueConditionEvaluationResult_Serialized[]required
evaluationsQueueConditionEvaluationResult_Evaluation_Serialized[]required
checksQueueCheck_Serialized[]required
namestringrequired
descriptionstringrequired
urlstring | nullrequired
details_urlstring | null
state"failure" | "error" | "cancelled" | "action_required" | "timed_out" | "pending" | "neutral" | "skipped" | "stale" | "success"required
Enum: failure error cancelled action_required timed_out pending neutral skipped stale success
avatar_urlstring | nullrequired
unsuccessful_checksQueueCheck_Serialized[]required
namestringrequired
descriptionstringrequired
urlstring | nullrequired
details_urlstring | null
state"failure" | "error" | "cancelled" | "action_required" | "timed_out" | "pending" | "neutral" | "skipped" | "stale" | "success"required
Enum: failure error cancelled action_required timed_out pending neutral skipped stale success
avatar_urlstring | nullrequired
pull_request_head_shastringrequired
session_idstring <uuid> | nullrequired
dequeue_code"PR_MERGED" | "PR_MERGED_INTERMEDIATE_RESULTS_SKIPPED" | "PR_DEQUEUED" | "PR_DEQUEUED_FROM_PARTITION" | "PR_AHEAD_DEQUEUED" | "BATCH_AHEAD_FAILED" | "PR_WITH_HIGHER_PRIORITY_QUEUED" | "SCHEDULED_FREEZE_STATUS_CHANGED" | "SPECULATIVE_CHECK_NUMBER_REDUCED" | "CHECKS_TIMEOUT" | "CHECKS_FAILED" | "DROPPED_BY_BISECTION_ELIMINATION" | "QUEUE_RULE_MISSING" | "BASE_BRANCH_MISSING" | "BASE_BRANCH_CHANGED" | "PR_UNEXPECTEDLY_FAILED_TO_MERGE" | "BATCH_MAX_FAILURE_RESOLUTION_ATTEMPTS" | "PR_CHECKS_STOPPED_BECAUSE_MERGE_QUEUE_PAUSE" | "CONFLICT_WITH_BASE_BRANCH" | "CONFLICT_WITH_PULL_AHEAD" | "BRANCH_UPDATE_FAILED" | "DRAFT_PULL_REQUEST_CHANGED" | "BATCH_PULL_REQUEST_CLOSED" | "PULL_REQUEST_UPDATED" | "MERGE_QUEUE_RESET" | "INCOMPATIBILITY_WITH_BRANCH_PROTECTIONS" | "PR_MANUALLY_MERGED" | "DRAFT_PULL_REQUEST_CREATION_FAILED" | "DRAFT_PULL_REQUEST_CREATION_BRANCH_NOT_INDEXED" | "CONFIGURATION_CHANGED" | "UNPROCESSABLE_PULL_REQUEST" | "PR_MANUALLY_DEQUEUED" | "STACK_PREDECESSOR_DEQUEUED" | "INTERMEDIATE_RESULTS_SKIPPED" | "CHECKS_RETRIED" | "SCHEDULE_BLOCKED_AHEAD_YIELDED" | "BASE_REF_ALIGNMENT_TIMEOUT" | "GITHUB_STACKED_PULL_REQUEST_MERGE_UNSUPPORTED" | "BATCH_SCOPES_CHANGED" | "BATCH_AHEAD_BRANCH_EDITED" | "CHECKS_INTERRUPTED" | "GITHUB_WORKFLOWS_PERMISSION_MISSING" | "BATCH_REBUILT" | "BATCH_AHEAD_REBUILT" | "GITHUB_REBASE_MERGE_REFUSED" | "PR_IN_SAME_BATCH_DEQUEUED" | nullrequired
batch_idstring <uuid> | nullrequired

The batch the pull request was in when it left the queue. Use it to correlate this leave with the batch's checks_start / checks_end events. Null when the pull request left before being embarked in a batch, or on events persisted before this field was added.

scopesstring[] | nullrequired

The scopes of the batch the pull request was in when it left. Empty when the queue is not scoped. Null when the pull request left before being embarked in a batch, or on events persisted before this field was added.

all_scopesboolean | nullrequired

Whether the batch the pull request was in impacted every scope (a merge-queue barrier). Null when the pull request left before being embarked in a batch, or on events persisted before this field was added.

conflicting_filesConflictingFiles | nullrequired

The files the merge stopped on, when the pull request left on a conflict: in listed, each with the strategy that declined it, if any, and what both sides changed, where that strategy named it, or how it was stopped, where it was, or whether no strategy is handed its conflict (no_strategy), ordered by path, and how many there are in count. listed holds every one of them up to 100, and the first 5 on an event recorded before it held more. Null when the pull request did not leave on a conflict, or the conflict was recorded without its files.

listedConflictingFile[]required
countintegerrequired
conflicting_branchstring | nullrequired

The branch the pull request left the queue conflicting with, as reason names it. Null when the pull request did not leave on a conflict with a branch, or the reason names none: it then reads the base branch.

conflicting_pull_request_numbersinteger[] | nullrequired

The pull requests ahead the pull request left the queue conflicting with, on a CONFLICT_WITH_PULL_AHEAD dequeue: the ones reason stands for, up to the first 100. Null otherwise, and on a dequeue whose conflict was with conflicting_branch.

conflict_resolution_advicePreviewstring | nullrequired

What automatic conflict resolution could do about the conflict the pull request left the queue on, as the markdown paragraph reason ends with. Null when there is nothing to advise, and when the pull request did not leave on a conflict.

deferred_behind_pull_request_countinteger | nullrequired

How many pull requests ahead the pull request was held behind before it left the queue conflicting with conflicting_branch, as reason says. Null when it was not held, when the pull request did not leave on a conflict with the base branch, and on an event recorded before it was counted.

action.queue.mergedEventQueueMerged
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueMergedMetadatarequired
branchstringrequired
queue_namestringrequired
queued_atstring <date-time>required
priority_rule_namestring | nullrequired
session_idstring <uuid>required
merge_commit_shastring | nullrequired

The commit this queue merge landed on the base branch (its new tip): a merge/squash commit, or the fast-forwarded head SHA for fast-forward merges. Null on events persisted before this field was added.

direct_mergeboolean | nullrequired

Whether scopes spared this merge its queue CI run: the queue merged the pull request on its own checks because every base branch commit it did not contain was a queue merge in scopes it does not touch. False when a queue CI run checked it, and when it was already up to date with the base branch, a case Direct Merge also merges with no queue CI run. Null on events persisted before this field was added.

action.rebaseEventRebase
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
metadataEventNoMetadatarequired
typestringrequired
action.refreshEventRefresh
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
metadataEventNoMetadatarequired
typestringrequired
action.request_reviewsEventRequestReviews
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventRequestReviewsMetadatarequired
reviewersstring[]required
team_reviewersstring[]required
action.reviewEventReview
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventReviewMetadatarequired
review_type"APPROVE" | "REQUEST_CHANGES" | "COMMENT"required
Enum: APPROVE REQUEST_CHANGES COMMENT
reviewerstring | nullrequired
messagestring | nullrequired
action.squashEventSquash
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
metadataEventNoMetadatarequired
typestringrequired
action.updateEventUpdate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
metadataEventNoMetadatarequired
typestringrequired
ci_insights.auto_quarantine.disabledEventCiInsightsAutoQuarantineDisabled
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCiInsightsAutoQuarantineDisabledMetadatarequired
disabled_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
disabled_atstring <date-time>required
auto_quarantine_config_attributesAutoQuarantineConfigEventLogAttributesrequired
ignore_broken_on_default_branchbooleanrequired
unquarantine_when_healthyboolean
disabled_by_staffbooleanrequired
ci_insights.auto_quarantine.enabledEventCiInsightsAutoQuarantineEnabled
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCiInsightsAutoQuarantineEnabledMetadatarequired
enabled_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
enabled_atstring <date-time>required
auto_quarantine_config_attributesAutoQuarantineConfigEventLogAttributesrequired
ignore_broken_on_default_branchbooleanrequired
unquarantine_when_healthyboolean
enabled_by_staffbooleanrequired
ci_insights.auto_quarantine.modifiedEventCiInsightsAutoQuarantineModified
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCiInsightsAutoQuarantineModifiedMetadatarequired
updated_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_atstring <date-time>required
auto_quarantine_config_attributes_beforeAutoQuarantineConfigEventLogAttributesrequired
ignore_broken_on_default_branchbooleanrequired
unquarantine_when_healthyboolean
auto_quarantine_config_attributes_afterAutoQuarantineConfigEventLogAttributesrequired
ignore_broken_on_default_branchbooleanrequired
unquarantine_when_healthyboolean
updated_by_staffbooleanrequired
ci_insights.job_retriedEventCiInsightsJobRetried
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCiInsightsJobRetriedMetadatarequired
rule_idstring <uuid>required
rule_namestringrequired
max_retryintegerrequired
retry_mode"job" | "pipeline"required
Enum: job pipeline
retry_attemptintegerrequired
condition_matches(SimpleConditionMatchSerialized | LogPatternAnnotationConditionMatchSerialized | LogPatternJobLogConditionMatchSerialized)[]required
outcome"retried" | "skipped_quota_exceeded"required
Enum: retried skipped_quota_exceeded
workflow_run_idinteger | nullrequired
job_urlstring | nullrequired
command.dequeueEventCommandDequeue
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCommandMetadatarequired
authorGitHubAccount | nullrequired

The GitHub account that asked. Null for a request made through the API with an application key, or by Mergify staff: requested_by names who asked.

loginstringrequired
idintegerrequired
type"User" | "Organization" | "Bot" | "Mannequin" | "Enterprise" | nullrequired
avatar_urlstring | null
comment_idinteger | nullrequired

The comment carrying the command. Null when no comment carried it: a request made through the API, or the copy of one on a pull request below it in a stack.

session_idstring <uuid> | nullrequired
command_trigger"comment" | "checkbox" | "api" | "dashboard" | nullrequired

How the request reached Mergify: a comment, a checkbox ticked in a Mergify comment, the dashboard, or another client of the API.

trigger_comment_urlstring | nullrequired
requested_byActor | nullrequired

Who asked, for a request made through the API or the dashboard: a GitHub user or an application key. Null for a command posted in a comment, whose author is who asked.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
requested_by_staffbooleanrequired

Whether requested_by is Mergify staff acting for support, whose identity is then shown as Mergify Staff.

command.queueEventCommandQueue
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventCommandMetadatarequired
authorGitHubAccount | nullrequired

The GitHub account that asked. Null for a request made through the API with an application key, or by Mergify staff: requested_by names who asked.

loginstringrequired
idintegerrequired
type"User" | "Organization" | "Bot" | "Mannequin" | "Enterprise" | nullrequired
avatar_urlstring | null
comment_idinteger | nullrequired

The comment carrying the command. Null when no comment carried it: a request made through the API, or the copy of one on a pull request below it in a stack.

session_idstring <uuid> | nullrequired
command_trigger"comment" | "checkbox" | "api" | "dashboard" | nullrequired

How the request reached Mergify: a comment, a checkbox ticked in a Mergify comment, the dashboard, or another client of the API.

trigger_comment_urlstring | nullrequired
requested_byActor | nullrequired

Who asked, for a request made through the API or the dashboard: a GitHub user or an application key. Null for a command posted in a comment, whose author is who asked.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
requested_by_staffbooleanrequired

Whether requested_by is Mergify staff acting for support, whose identity is then shown as Mergify Staff.

conflict_resolution.attemptPreviewEventConflictResolutionAttempt
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventConflictResolutionAttemptMetadatarequired
outcome"pushed" | "unresolved" | "failed" | "resolvable" | "rebase"required

What came of merging the base branch into the pull request under the repository's conflict_resolvers. pushed: every conflict was settled, and Mergify pushed the merge into the pull request. unresolved: a conflict is left, so nothing was pushed. failed: the merge, or its push, failed, so nothing was pushed. resolvable: every conflict is settled, and the merge queue resolves them when it merges the pull request, so nothing was pushed. rebase: the pull request is merged or updated by rebase, which the merge commit a resolution is carried by does not survive, so Mergify merged nothing: a rebase gets no resolution, by design. That is its queue rule's merge_method or update_method rebase, a base branch that allows only rebase merging, or a merge action with method rebase that may apply to it.

Enum: pushed unresolved failed resolvable rebase
titlestringrequired

The title of the pull request's conflict resolution check run for this attempt. A failed attempt's title names the failure when Mergify can tell what it was, and otherwise only says that the conflicts with the base branch could not be resolved. A rebase attempt has no check run, and its title says why.

base_shastringrequired

The base branch's head that was merged.

head_shastringrequired

The pull request's head it was merged into.

pushed_shastring | nullrequired

The merge commit pushed into the pull request, when the outcome is pushed.

conflicting_pathsEventConflictResolutionPath[]required

Every path of the merge that conflicted, or that automatic conflict resolution settled, sorted by path. A path covered by ours, theirs or union is listed wherever both sides changed it, conflicting or not.

pathstringrequired

The path, relative to the repository root.

resolver"union" | "ours" | "theirs" | "prefer-ours" | "prefer-theirs" | "json" | "pnpm" | "uv" | "rails-schema" | "yarn" | "typescript" | "rails-structure" | "rust" | "python" | "yaml" | "cargo" | "npm" | "go" | "gomod" | "sbt" | "terraform" | "nix" | "ruby" | "swift" | "mix" | "hcl" | "haskell" | "java" | "csharp" | "kotlin" | "php" | "c" | "toml" | "css" | "pip" | "dockerfile" | "xml" | "nuget" | "gradle" | "composer" | "astro" | "markdown" | "manual" | "text" | nullrequired

The strategy from the repository's conflict_resolvers that applies to this path, as written in the configuration. Null when no entry covers the path.

outcome"resolved" | "unresolved"required

What came of the path. resolved: the resolver settled it, the way its strategy says. unresolved: the path still conflicts.

Enum: resolved unresolved
stopped"timed_out" | "killed"

For an unresolved path, how Mergify stopped its resolver before it could merge or decline it. timed_out: it ran past its time limit. killed: it was killed, because it outlived that limit or ran out of memory. Absent where the resolver was not stopped, and from events recorded before this field existed.

Enum: timed_out killed
not_readboolean

True where its strategy could not read the path.

no_driver_pathsstring[]required

The conflicting paths no strategy is handed whatever the configuration says: a deletion, a rename, a symbolic link or a submodule. Sorted.

composedbooleanrequired

Whether the strategies ran. False when another path conflicts whatever they do, so an unresolved path a strategy covers was left without it running, rather than declined by it.

product.disabledEventProductDisabled
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventProductDisabledMetadatarequired
product"ci_insights" | "merge_protections" | "workflow_automation" | "merge_queue" | "job_engine"required
Enum: ci_insights merge_protections workflow_automation merge_queue job_engine
disabled_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
disabled_atstring <date-time>required
disabled_by_staffbooleanrequired
product.enabledEventProductEnabled
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventProductEnabledMetadatarequired
product"ci_insights" | "merge_protections" | "workflow_automation" | "merge_queue" | "job_engine"required
Enum: ci_insights merge_protections workflow_automation merge_queue job_engine
enabled_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
enabled_atstring <date-time>required
enabled_by_staffbooleanrequired
queue.batch_run_endEventQueueBatchRunEnd
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueBatchRunEndMetadatarequired
queue_namestringrequired
branchstringrequired
run_idstring <uuid>required

The CI run, which the start, the end and every per-pull-request checks_start and checks_end of it share.

batch_idstring <uuid>required

The batch the run checks. A batch checked again -- a retry, an update of the pull request checked in place -- starts another run under the same batch id.

batch_namestring | nullrequired

The display name of the batch this event concerns, the same name the merge queue shows while the batch is queued. Recorded on the event because the name lives only in the live queue state and is unrecoverable once the batch leaves the queue. Null on events persisted before this field was added.

parent_batch_idsstring <uuid>[]required

The batches the run's batch was queued behind when it started.

scopesstring[]required
all_scopesbooleanrequired
method"queue_branch" | "in_place"required

How the queue checks the batch: on a branch it pushes with the batch's pull requests merged onto the base (queue_branch), or on the queued pull request itself, updated with the base (in_place). A direct merge, which runs no checks (ci_skipped), names the mode the queue would have used.

Enum: queue_branch in_place
checks_pull_request_numberinteger | nullrequired

The pull request whose checks the run reads: the batch's draft pull request, or the queued pull request itself, in place and for a direct merge. Null when the queue checks the batch on its merge queue branch without opening a draft pull request: head_sha and queue_branch_name name what the run checks then.

head_shastring | nullrequired

The commit the run started checking: the head of the draft pull request or of the merge queue branch, or of the queued pull request itself, in place and for a direct merge. The end of the run repeats it, even when an edit allowed on the merge queue branch moved its head since. Null on the events of a run a release that predates this field saved.

queue_branch_namestring | nullrequired

The merge queue branch the run checks. Null when the queued pull request is checked in place or merged directly, and on the events of a run a release that predates this field saved.

ci_skippedbooleanrequired

Whether the run is a direct merge: the queue ran no checks, and merges the pull request on the checks it already passed.

attemptintegerrequired

How many checks retries of the batch preceded the run.

min: 0
bisection_depthintegerrequired

How many splits of a failing batch the run's batch descends from: 0 for a batch checked as it was embarked.

min: 0
start_cause"first" | "retry" | "bisection" | "base_update" | "reembark" | nullrequired

Why the run started: the pull requests' first check, a retry of failed checks, a sub-batch of a bisection, a base_update of a batch checked again on a new base, or pull requests checked again after their previous batch was torn down (reembark). Null on the end of a run started before the run events existed.

previous_run_idstring <uuid> | nullrequired

The run the batch ran before this one, which this one replaced. Null on a batch's first run.

ciEventQueueBatchRunCirequired
conclusion"success" | "failure" | "timed_out" | "cancelled" | "skipped"required

How the run's checks first concluded. cancelled when the run was torn down before they did, skipped when no CI ran.

Enum: success failure timed_out cancelled skipped
started_atstring <date-time>required
ended_atstring <date-time> | nullrequired

When the checks first concluded. Null when they never did.

unsuccessful_checksQueueCheck_Serialized[]required
failure_firstEventQueueBatchRunFailureFirst | nullrequired

What the run's jobs did when told to run first the tests they failed in the bisection step above, as they had reported it when the run ended. Null when no job of the run was told to, or when it could not be recorded.

jobsintegerrequired

The run's jobs told to run first the tests they failed in the bisection step above.

min: 1
tests_run_firstintegerrequired

How many tests those jobs were told to run first, summed.

min: 0
stopped_early_jobsintegerrequired

Of those jobs, the ones that had stopped, when the run ended, before running the rest of their tests in a session that failed one of the tests they were told to run first. A job still running then is not counted.

min: 0
estimated_test_time_saved_msintegerrequired

Test time the jobs that stopped early did not spend: for each, the median test time of the same job over the last 30 days of bisection steps where it ran all its tests, minus its own.

min: 0
unmeasured_stopped_early_jobsintegerrequired

Jobs that stopped early but never ran all their tests in a bisection step of the last 30 days: left out of the time saved.

min: 0
end_code"PR_DEQUEUED" | "PR_DEQUEUED_FROM_PARTITION" | "PR_AHEAD_DEQUEUED" | "BATCH_AHEAD_FAILED" | "PR_WITH_HIGHER_PRIORITY_QUEUED" | "SCHEDULED_FREEZE_STATUS_CHANGED" | "SPECULATIVE_CHECK_NUMBER_REDUCED" | "CHECKS_TIMEOUT" | "CHECKS_FAILED" | "DROPPED_BY_BISECTION_ELIMINATION" | "QUEUE_RULE_MISSING" | "BASE_BRANCH_MISSING" | "BASE_BRANCH_CHANGED" | "PR_UNEXPECTEDLY_FAILED_TO_MERGE" | "BATCH_MAX_FAILURE_RESOLUTION_ATTEMPTS" | "PR_CHECKS_STOPPED_BECAUSE_MERGE_QUEUE_PAUSE" | "CONFLICT_WITH_BASE_BRANCH" | "CONFLICT_WITH_PULL_AHEAD" | "BRANCH_UPDATE_FAILED" | "DRAFT_PULL_REQUEST_CHANGED" | "BATCH_PULL_REQUEST_CLOSED" | "PULL_REQUEST_UPDATED" | "MERGE_QUEUE_RESET" | "INCOMPATIBILITY_WITH_BRANCH_PROTECTIONS" | "PR_MANUALLY_MERGED" | "DRAFT_PULL_REQUEST_CREATION_FAILED" | "DRAFT_PULL_REQUEST_CREATION_BRANCH_NOT_INDEXED" | "CONFIGURATION_CHANGED" | "UNPROCESSABLE_PULL_REQUEST" | "PR_MANUALLY_DEQUEUED" | "STACK_PREDECESSOR_DEQUEUED" | "INTERMEDIATE_RESULTS_SKIPPED" | "CHECKS_RETRIED" | "SCHEDULE_BLOCKED_AHEAD_YIELDED" | "BASE_REF_ALIGNMENT_TIMEOUT" | "GITHUB_STACKED_PULL_REQUEST_MERGE_UNSUPPORTED" | "BATCH_SCOPES_CHANGED" | "BATCH_AHEAD_BRANCH_EDITED" | "CHECKS_INTERRUPTED" | "GITHUB_WORKFLOWS_PERMISSION_MISSING" | "BATCH_REBUILT" | "BATCH_AHEAD_REBUILT" | "GITHUB_REBASE_MERGE_REFUSED" | "PR_IN_SAME_BATCH_DEQUEUED" | nullrequired

Why the run ended without merging anything. Null when it merged a pull request.

pull_requestsEventQueueBatchRunEndPullRequest[]required

Every pull request the run had a part in.

numberintegerrequired
min: 1 · max: 9223372036854776000
session_idstring <uuid>required
verdict"merged" | "reembarked" | "convicted" | "removed"required

What the run did for the pull request: it merged from it, was reembarked to be checked by another run, was convicted by the run's checks and left the queue, or was removed from the queue for a reason other than the run's checks.

Enum: merged reembarked convicted removed
code"PR_MERGED" | "PR_MERGED_INTERMEDIATE_RESULTS_SKIPPED" | "PR_DEQUEUED" | "PR_DEQUEUED_FROM_PARTITION" | "PR_AHEAD_DEQUEUED" | "BATCH_AHEAD_FAILED" | "PR_WITH_HIGHER_PRIORITY_QUEUED" | "SCHEDULED_FREEZE_STATUS_CHANGED" | "SPECULATIVE_CHECK_NUMBER_REDUCED" | "CHECKS_TIMEOUT" | "CHECKS_FAILED" | "DROPPED_BY_BISECTION_ELIMINATION" | "QUEUE_RULE_MISSING" | "BASE_BRANCH_MISSING" | "BASE_BRANCH_CHANGED" | "PR_UNEXPECTEDLY_FAILED_TO_MERGE" | "BATCH_MAX_FAILURE_RESOLUTION_ATTEMPTS" | "PR_CHECKS_STOPPED_BECAUSE_MERGE_QUEUE_PAUSE" | "CONFLICT_WITH_BASE_BRANCH" | "CONFLICT_WITH_PULL_AHEAD" | "BRANCH_UPDATE_FAILED" | "DRAFT_PULL_REQUEST_CHANGED" | "BATCH_PULL_REQUEST_CLOSED" | "PULL_REQUEST_UPDATED" | "MERGE_QUEUE_RESET" | "INCOMPATIBILITY_WITH_BRANCH_PROTECTIONS" | "PR_MANUALLY_MERGED" | "DRAFT_PULL_REQUEST_CREATION_FAILED" | "DRAFT_PULL_REQUEST_CREATION_BRANCH_NOT_INDEXED" | "CONFIGURATION_CHANGED" | "UNPROCESSABLE_PULL_REQUEST" | "PR_MANUALLY_DEQUEUED" | "STACK_PREDECESSOR_DEQUEUED" | "INTERMEDIATE_RESULTS_SKIPPED" | "CHECKS_RETRIED" | "SCHEDULE_BLOCKED_AHEAD_YIELDED" | "BASE_REF_ALIGNMENT_TIMEOUT" | "GITHUB_STACKED_PULL_REQUEST_MERGE_UNSUPPORTED" | "BATCH_SCOPES_CHANGED" | "BATCH_AHEAD_BRANCH_EDITED" | "CHECKS_INTERRUPTED" | "GITHUB_WORKFLOWS_PERMISSION_MISSING" | "BATCH_REBUILT" | "BATCH_AHEAD_REBUILT" | "GITHUB_REBASE_MERGE_REFUSED" | "PR_IN_SAME_BATCH_DEQUEUED" | nullrequired

The code of the reason the pull request left the run. Null when the run recorded none.

queue.batch_run_startEventQueueBatchRunStart
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueueBatchRunStartMetadatarequired
queue_namestringrequired
branchstringrequired
run_idstring <uuid>required

The CI run, which the start, the end and every per-pull-request checks_start and checks_end of it share.

batch_idstring <uuid>required

The batch the run checks. A batch checked again -- a retry, an update of the pull request checked in place -- starts another run under the same batch id.

batch_namestring | nullrequired

The display name of the batch this event concerns, the same name the merge queue shows while the batch is queued. Recorded on the event because the name lives only in the live queue state and is unrecoverable once the batch leaves the queue. Null on events persisted before this field was added.

parent_batch_idsstring <uuid>[]required

The batches the run's batch was queued behind when it started.

scopesstring[]required
all_scopesbooleanrequired
method"queue_branch" | "in_place"required

How the queue checks the batch: on a branch it pushes with the batch's pull requests merged onto the base (queue_branch), or on the queued pull request itself, updated with the base (in_place). A direct merge, which runs no checks (ci_skipped), names the mode the queue would have used.

Enum: queue_branch in_place
checks_pull_request_numberinteger | nullrequired

The pull request whose checks the run reads: the batch's draft pull request, or the queued pull request itself, in place and for a direct merge. Null when the queue checks the batch on its merge queue branch without opening a draft pull request: head_sha and queue_branch_name name what the run checks then.

head_shastring | nullrequired

The commit the run started checking: the head of the draft pull request or of the merge queue branch, or of the queued pull request itself, in place and for a direct merge. The end of the run repeats it, even when an edit allowed on the merge queue branch moved its head since. Null on the events of a run a release that predates this field saved.

queue_branch_namestring | nullrequired

The merge queue branch the run checks. Null when the queued pull request is checked in place or merged directly, and on the events of a run a release that predates this field saved.

ci_skippedbooleanrequired

Whether the run is a direct merge: the queue ran no checks, and merges the pull request on the checks it already passed.

attemptintegerrequired

How many checks retries of the batch preceded the run.

min: 0
bisection_depthintegerrequired

How many splits of a failing batch the run's batch descends from: 0 for a batch checked as it was embarked.

min: 0
start_cause"first" | "retry" | "bisection" | "base_update" | "reembark" | nullrequired

Why the run started: the pull requests' first check, a retry of failed checks, a sub-batch of a bisection, a base_update of a batch checked again on a new base, or pull requests checked again after their previous batch was torn down (reembark). Null on the end of a run started before the run events existed.

previous_run_idstring <uuid> | nullrequired

The run the batch ran before this one, which this one replaced. Null on a batch's first run.

pull_requestsEventQueueBatchRunStartPullRequest[]required

The pull requests the run checks.

numberintegerrequired
min: 1 · max: 9223372036854776000
session_idstring <uuid>required
priority_rule_namestring | nullrequired
queued_atstring <date-time>required
queue.pause.createEventQueuePauseCreate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueuePauseCreateMetadatarequired
reasonstringrequired
created_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
created_by_staffbooleanrequired
queue.pause.deleteEventQueuePauseDelete
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueuePauseDeleteMetadatarequired
deleted_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
deleted_by_staffbooleanrequired
queue.pause.updateEventQueuePauseUpdate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventQueuePauseUpdateMetadatarequired
reasonstringrequired
updated_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_by_staffbooleanrequired
scheduled_freeze.createEventScheduledFreezeCreate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventScheduledFreezeCreateMetadatarequired
scheduled_freeze_attributesScheduledFreezeEventLogAttributesrequired
reasonstringrequired
startstring <date-time>required
endstring <date-time> | nullrequired
timezonestringrequired
matching_conditions(MatchingConditionsDict-Output | string)[]required
exclude_conditions(MatchingConditionsDict-Output | string)[]required
created_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
created_atstring <date-time>required
created_by_staffbooleanrequired
scheduled_freeze.deleteEventScheduledFreezeDelete
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventScheduledFreezeDeleteMetadatarequired
scheduled_freeze_attributesScheduledFreezeEventLogAttributesrequired
reasonstringrequired
startstring <date-time>required
endstring <date-time> | nullrequired
timezonestringrequired
matching_conditions(MatchingConditionsDict-Output | string)[]required
exclude_conditions(MatchingConditionsDict-Output | string)[]required
reasonstringrequired
deleted_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
deleted_atstring <date-time>required
deleted_by_staffbooleanrequired
scheduled_freeze.updateEventScheduledFreezeUpdate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventScheduledFreezeUpdateMetadatarequired
scheduled_freeze_attributes_beforeScheduledFreezeEventLogAttributesrequired
reasonstringrequired
startstring <date-time>required
endstring <date-time> | nullrequired
timezonestringrequired
matching_conditions(MatchingConditionsDict-Output | string)[]required
exclude_conditions(MatchingConditionsDict-Output | string)[]required
scheduled_freeze_attributes_afterScheduledFreezeEventLogAttributesrequired
reasonstringrequired
startstring <date-time>required
endstring <date-time> | nullrequired
timezonestringrequired
matching_conditions(MatchingConditionsDict-Output | string)[]required
exclude_conditions(MatchingConditionsDict-Output | string)[]required
updated_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_atstring <date-time>required
updated_by_staffbooleanrequired
test.health.changedEventTestHealthChanged
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventTestHealthChangedMetadatarequired
test_idstring <uuid>
test_namestringrequired
branch_namestringrequired
pipeline_namestringrequired
job_namestringrequired
from_state"healthy" | "flaky" | "broken"required
Enum: healthy flaky broken
to_state"healthy" | "flaky" | "broken"required
Enum: healthy flaky broken
signalTestHealthTransitionSignalrequired
head_shastringrequired
changed_atstring <date-time>required
test.state.addedEventTestStateAdded
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventTestStateAddedMetadatarequired
test_state_idstring <uuid>required
test_idstring <uuid>
test_namestringrequired
state"quarantined" | "skipped"required
Enum: quarantined skipped
source"manual" | "auto"required
Enum: manual auto
reasonstringrequired
branch_namestring | nullrequired
pipeline_namestring | nullrequired
job_namestring | nullrequired
added_atstring <date-time>required
health_status_at_event"healthy" | "flaky" | "broken"required
Enum: healthy flaky broken
added_byActor | nullrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
added_by_staffbooleanrequired
test.state.removedEventTestStateRemoved
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventTestStateRemovedMetadatarequired
test_state_idstring <uuid>required
test_idstring <uuid>
test_namestringrequired
state"quarantined" | "skipped"required
Enum: quarantined skipped
source"manual" | "auto"required
Enum: manual auto
original_test_stateTestStateSnapshotrequired
source"manual" | "auto"required
Enum: manual auto
reasonstringrequired
branch_namestring | nullrequired
pipeline_namestring | nullrequired
job_namestring | nullrequired
created_atstring <date-time>required
health_status_at_event"healthy" | "flaky" | "broken"required
Enum: healthy flaky broken
removed_atstring <date-time>required
removed_byActor | nullrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
removed_by_staffbooleanrequired
test_retry.disabledEventTestRetryDisabled
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventTestRetryDisabledMetadatarequired
disabled_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
disabled_atstring <date-time>required
test_retry_config_attributesTestRetryConfigEventLogAttributesrequired
budget_ratioTestRetryBudgetRatioEventLogAttributesrequired
max_retries_per_testTestRetryMaxRetriesPerTestEventLogAttributesrequired
disabled_by_staffbooleanrequired
test_retry.enabledEventTestRetryEnabled
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventTestRetryEnabledMetadatarequired
enabled_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
enabled_atstring <date-time>required
test_retry_config_attributesTestRetryConfigEventLogAttributesrequired
budget_ratioTestRetryBudgetRatioEventLogAttributesrequired
max_retries_per_testTestRetryMaxRetriesPerTestEventLogAttributesrequired
enabled_by_staffbooleanrequired
test_retry.modifiedEventTestRetryModified
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
outcome"success" | "failure" | "pending" | "neutral"required
Enum: success failure pending neutral
typestringrequired
metadataEventTestRetryModifiedMetadatarequired
updated_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_atstring <date-time>required
test_retry_config_attributes_beforeTestRetryConfigEventLogAttributesrequired
budget_ratioTestRetryBudgetRatioEventLogAttributesrequired
max_retries_per_testTestRetryMaxRetriesPerTestEventLogAttributesrequired
test_retry_config_attributes_afterTestRetryConfigEventLogAttributesrequired
budget_ratioTestRetryBudgetRatioEventLogAttributesrequired
max_retries_per_testTestRetryMaxRetriesPerTestEventLogAttributesrequired
updated_by_staffbooleanrequired
Example Response
                          {
  "size": 0,
  "per_page": 0,
  "events": [
    {
      "id": 0,
      "received_at": "2024-01-15T09:00:00Z",
      "trigger": "string",
      "repository": "string",
      "pull_request": 0,
      "base_ref": "string",
      "outcome": "success",
      "type": "action.assign",
      "metadata": {}
    }
  ]
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_NOT_NEWER" | "API_VERSION_ROLLBACK_UNAVAILABLE" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_POLICY_INVALID_PATTERN" | "MERGE_QUEUE_POLICY_LIMIT_REACHED" | "MERGE_QUEUE_POLICY_NAME_TAKEN" | "MERGE_QUEUE_POLICY_NOT_FOUND" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED" | "PIPELINE_CACHE_ENTRY_NOT_FOUND" | "PIPELINE_CACHE_NOT_ENABLED" | "PIPELINE_CACHE_NO_STORAGE_CONNECTION" | "PIPELINE_CACHE_READ_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "STORAGE_POLICY_LIMIT_REACHED" | "STORAGE_POLICY_NAME_TAKEN" | "STORAGE_POLICY_NOT_FOUND" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_NOT_NEWER API_VERSION_ROLLBACK_UNAVAILABLE API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_POLICY_INVALID_PATTERN MERGE_QUEUE_POLICY_LIMIT_REACHED MERGE_QUEUE_POLICY_NAME_TAKEN MERGE_QUEUE_POLICY_NOT_FOUND MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED PIPELINE_CACHE_ENTRY_NOT_FOUND PIPELINE_CACHE_NOT_ENABLED PIPELINE_CACHE_NO_STORAGE_CONNECTION PIPELINE_CACHE_READ_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE STORAGE_POLICY_LIMIT_REACHED STORAGE_POLICY_NAME_TAKEN STORAGE_POLICY_NOT_FOUND SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 Forbidden
404 Not found
409 Conflict
422 ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED: This event type cannot be filtered on that metadata.* key. detail names the filters that reach the same events.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_NOT_NEWER" | "API_VERSION_ROLLBACK_UNAVAILABLE" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_POLICY_INVALID_PATTERN" | "MERGE_QUEUE_POLICY_LIMIT_REACHED" | "MERGE_QUEUE_POLICY_NAME_TAKEN" | "MERGE_QUEUE_POLICY_NOT_FOUND" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED" | "PIPELINE_CACHE_ENTRY_NOT_FOUND" | "PIPELINE_CACHE_NOT_ENABLED" | "PIPELINE_CACHE_NO_STORAGE_CONNECTION" | "PIPELINE_CACHE_READ_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "STORAGE_POLICY_LIMIT_REACHED" | "STORAGE_POLICY_NAME_TAKEN" | "STORAGE_POLICY_NOT_FOUND" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_NOT_NEWER API_VERSION_ROLLBACK_UNAVAILABLE API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_POLICY_INVALID_PATTERN MERGE_QUEUE_POLICY_LIMIT_REACHED MERGE_QUEUE_POLICY_NAME_TAKEN MERGE_QUEUE_POLICY_NOT_FOUND MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED PIPELINE_CACHE_ENTRY_NOT_FOUND PIPELINE_CACHE_NOT_ENABLED PIPELINE_CACHE_NO_STORAGE_CONNECTION PIPELINE_CACHE_READ_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE STORAGE_POLICY_LIMIT_REACHED STORAGE_POLICY_NAME_TAKEN STORAGE_POLICY_NOT_FOUND SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/logs" \
  -H "Authorization: Bearer <token>"

Get aggregated event counts #

GET /repos/{owner}/{repository}/logs/aggregate

Aggregations (total / histogram / event-type / outcome / trigger / pull-request / batch-pull-request facet counts) over the same filter set as /logs. The response stays consistent with what the row endpoint returns: total matches what the table will show; unchecked values produce no row in their facet list (the sidebar hides their count rather than display 0). by_outcome is derived from event.type (most types map directly; a few refine the label from event metadata); by_trigger, by_pull_request, and by_batch_pull_request return the top 200 values by count in the window, self-excluding their own filters.

Application key permission: activity_log: read.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
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\-]+$

pull_request integer[]

Filter events by pull-request number: an event matches when it belongs to any of the given pull requests, as its pull_request or as one of the several an event about a batch belongs to. Repeatable to match several PRs at once (e.g. ?pull_request=1&pull_request=2).

base_ref string

Get events for PRs to the given base ref

min length: 1 · max length: 255

batch_pull integer[]

Filter to batch (draft) pull requests' own lifecycle events by number (surfaced in the dashboard as "Batch Pull Request"). Repeatable to match several batches at once. The draft PR is the Mergify-opened pull request that speculatively checks a batch; this returns each batch's action.queue.checks_start / action.queue.checks_end events (which snapshot the draft PR number), the queue.batch_run_start / queue.batch_run_end events of the runs those belong to, and the batch's bisection events. When in_place is true the number is the user's own PR rather than a Mergify draft. The number rotates on checks-retry — each event snapshots the number at that attempt. Mutually exclusive with not_batch_pull (exclusion).

not_batch_pull integer[]

Exclude batch (draft) pull requests' own lifecycle events by number — the same event set batch_pull includes, negated. Repeatable. Mirrors Datadog's facet semantics: unchecking a batch pull request in the dashboard sidebar adds it to the exclusion list. Mutually exclusive with batch_pull (positive include).

event_type ("action.assign" | "action.backport" | "action.close" | "action.comment" | "action.copy" | "action.delete_head_branch" | "action.dequeue" | "action.dismiss_reviews" | "action.edit" | "action.github_actions" | "action.label" | "action.label.loop_stopped" | "action.merge" | "action.post_check" | "action.queue.batch_bisection_end" | "action.queue.batch_bisection_start" | "action.queue.batch_composition" | "action.queue.change" | "action.queue.checks.change" | "action.queue.checks_end" | "action.queue.checks_postponed" | "action.queue.checks_start" | "action.queue.conflict_deferred" | "action.queue.enter" | "action.queue.leave" | "action.queue.merged" | "action.rebase" | "action.refresh" | "action.request_reviews" | "action.review" | "action.squash" | "action.update" | "ci_insights.auto_quarantine.disabled" | "ci_insights.auto_quarantine.enabled" | "ci_insights.auto_quarantine.modified" | "ci_insights.job_retried" | "command.dequeue" | "command.queue" | "conflict_resolution.attempt" | "product.disabled" | "product.enabled" | "queue.batch_run_end" | "queue.batch_run_start" | "queue.pause.create" | "queue.pause.delete" | "queue.pause.update" | "scheduled_freeze.create" | "scheduled_freeze.delete" | "scheduled_freeze.update" | "test.health.changed" | "test.state.added" | "test.state.removed" | "test_retry.disabled" | "test_retry.enabled" | "test_retry.modified")[]

The specific types of events to select. action.queue.checks_not_started is accepted as a deprecated alias of action.queue.checks_postponed. test.quarantined and test.dequarantined are deprecated and will be removed: use test.state.added and test.state.removed. Until then they select the events of those types whose metadata.state is quarantined, returned under those types.

not_event_type ("action.assign" | "action.backport" | "action.close" | "action.comment" | "action.copy" | "action.delete_head_branch" | "action.dequeue" | "action.dismiss_reviews" | "action.edit" | "action.github_actions" | "action.label" | "action.label.loop_stopped" | "action.merge" | "action.post_check" | "action.queue.batch_bisection_end" | "action.queue.batch_bisection_start" | "action.queue.batch_composition" | "action.queue.change" | "action.queue.checks.change" | "action.queue.checks_end" | "action.queue.checks_postponed" | "action.queue.checks_start" | "action.queue.conflict_deferred" | "action.queue.enter" | "action.queue.leave" | "action.queue.merged" | "action.rebase" | "action.refresh" | "action.request_reviews" | "action.review" | "action.squash" | "action.update" | "ci_insights.auto_quarantine.disabled" | "ci_insights.auto_quarantine.enabled" | "ci_insights.auto_quarantine.modified" | "ci_insights.job_retried" | "command.dequeue" | "command.queue" | "conflict_resolution.attempt" | "product.disabled" | "product.enabled" | "queue.batch_run_end" | "queue.batch_run_start" | "queue.pause.create" | "queue.pause.delete" | "queue.pause.update" | "scheduled_freeze.create" | "scheduled_freeze.delete" | "scheduled_freeze.update" | "test.health.changed" | "test.state.added" | "test.state.removed" | "test_retry.disabled" | "test_retry.enabled" | "test_retry.modified")[]

Exclude events whose type matches any of the given values. Mutually exclusive with event_type (positive include). action.queue.checks_not_started is accepted as a deprecated alias of action.queue.checks_postponed. test.quarantined and test.dequarantined are deprecated and will be removed: use test.state.added and test.state.removed. Until then they select the events of those types whose metadata.state is quarantined, returned under those types.

outcome ("success" | "failure" | "pending" | "neutral")[]

Filter events by derived outcome label (success / failure / pending / neutral). Repeatable to match several outcomes at once (e.g. ?outcome=success&outcome=failure).

not_outcome ("success" | "failure" | "pending" | "neutral")[]

Exclude events whose derived outcome label matches any of the given values (success / failure / pending / neutral). Repeatable. Mirrors Datadog's facet semantics: unchecking an outcome in the dashboard sidebar adds it to the exclusion list. Mutually exclusive with outcome (positive include).

trigger string[]

Include only events whose trigger matches one of the given values (exact match). Repeatable. Mirrors Datadog's facet behaviour after clicking Only: the URL switches from exclusion mode to inclusion mode with a positive list — shorter than not_trigger=<everything else>. Mutually exclusive with not_trigger.

not_trigger string[]

Exclude events whose trigger matches any of the given values (exact match). Repeatable. Mirrors Datadog's facet semantics: the default state is all triggers included, and unchecking a trigger in the dashboard sidebar adds it to the exclusion list. Mutually exclusive with trigger (positive include).

not_pull_request integer[]

Exclude events that belong to any of the given pull requests, the way pull_request matches them. Mutually exclusive with pull_request (positive include).

received_from 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 received_to - 1 day.

received_to 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 now.

200 Successful Response
totalintegerrequired
interval_size_secondsintegerrequired
histogramHistogramBucket[]required
startstring <date-time>required
endstring <date-time>required
countintegerrequired
by_event_typeFacetCount[]required
valuestringrequired
countintegerrequired
by_outcomeFacetCount[]required
valuestringrequired
countintegerrequired
by_triggerFacetCount[]required
valuestringrequired
countintegerrequired
by_pull_requestFacetCount[]required
valuestringrequired
countintegerrequired
by_batch_pull_requestFacetCount[]required
valuestringrequired
countintegerrequired
Example Response
                          {
  "total": 0,
  "interval_size_seconds": 0,
  "histogram": [
    {
      "start": "2024-01-15T09:00:00Z",
      "end": "2024-01-15T09:00:00Z",
      "count": 0
    }
  ],
  "by_event_type": [
    {
      "value": "string",
      "count": 0
    }
  ],
  "by_outcome": [
    {
      "value": "string",
      "count": 0
    }
  ],
  "by_trigger": [
    {
      "value": "string",
      "count": 0
    }
  ],
  "by_pull_request": [
    {
      "value": "string",
      "count": 0
    }
  ],
  "by_batch_pull_request": [
    {
      "value": "string",
      "count": 0
    }
  ]
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_NOT_NEWER" | "API_VERSION_ROLLBACK_UNAVAILABLE" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_POLICY_INVALID_PATTERN" | "MERGE_QUEUE_POLICY_LIMIT_REACHED" | "MERGE_QUEUE_POLICY_NAME_TAKEN" | "MERGE_QUEUE_POLICY_NOT_FOUND" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED" | "PIPELINE_CACHE_ENTRY_NOT_FOUND" | "PIPELINE_CACHE_NOT_ENABLED" | "PIPELINE_CACHE_NO_STORAGE_CONNECTION" | "PIPELINE_CACHE_READ_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "STORAGE_POLICY_LIMIT_REACHED" | "STORAGE_POLICY_NAME_TAKEN" | "STORAGE_POLICY_NOT_FOUND" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_NOT_NEWER API_VERSION_ROLLBACK_UNAVAILABLE API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_POLICY_INVALID_PATTERN MERGE_QUEUE_POLICY_LIMIT_REACHED MERGE_QUEUE_POLICY_NAME_TAKEN MERGE_QUEUE_POLICY_NOT_FOUND MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED PIPELINE_CACHE_ENTRY_NOT_FOUND PIPELINE_CACHE_NOT_ENABLED PIPELINE_CACHE_NO_STORAGE_CONNECTION PIPELINE_CACHE_READ_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE STORAGE_POLICY_LIMIT_REACHED STORAGE_POLICY_NAME_TAKEN STORAGE_POLICY_NOT_FOUND SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 Forbidden
404 Not found
409 Conflict
422 ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED: This event type cannot be filtered on that metadata.* key. detail names the filters that reach the same events.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_NOT_NEWER" | "API_VERSION_ROLLBACK_UNAVAILABLE" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "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_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_POLICY_INVALID_PATTERN" | "MERGE_QUEUE_POLICY_LIMIT_REACHED" | "MERGE_QUEUE_POLICY_NAME_TAKEN" | "MERGE_QUEUE_POLICY_NOT_FOUND" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED" | "PIPELINE_CACHE_ENTRY_NOT_FOUND" | "PIPELINE_CACHE_NOT_ENABLED" | "PIPELINE_CACHE_NO_STORAGE_CONNECTION" | "PIPELINE_CACHE_READ_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "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_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "STORAGE_POLICY_LIMIT_REACHED" | "STORAGE_POLICY_NAME_TAKEN" | "STORAGE_POLICY_NOT_FOUND" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_NOT_NEWER API_VERSION_ROLLBACK_UNAVAILABLE API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_FOUND 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_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_POLICY_INVALID_PATTERN MERGE_QUEUE_POLICY_LIMIT_REACHED MERGE_QUEUE_POLICY_NAME_TAKEN MERGE_QUEUE_POLICY_NOT_FOUND MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED PIPELINE_CACHE_ENTRY_NOT_FOUND PIPELINE_CACHE_NOT_ENABLED PIPELINE_CACHE_NO_STORAGE_CONNECTION PIPELINE_CACHE_READ_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED 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_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE STORAGE_POLICY_LIMIT_REACHED STORAGE_POLICY_NAME_TAKEN STORAGE_POLICY_NOT_FOUND SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
Example Request
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/logs/aggregate" \
  -H "Authorization: Bearer <token>"

Was this page helpful?