Event Logs

Retrieve event logs for pull request activity.

Get the events log

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

Get the events logs of the requested repository

Authorization (any one of)
Application Key GitHub Token
Path Parameters
owner string required

The owner of the repository

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

repository string required

The name of the repository

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

Query Parameters
pull_request integer

Get the events for the specified pull request

min: 1 · exclusive max: 2147483647

base_ref string

Get events for PRs to the given base ref

min length: 1 · max length: 255

event_type "action.assign" | "action.backport" | "action.close" | "action.comment" | "action.copy" | "action.delete_head_branch" | "action.dismiss_reviews" | "action.edit" | "action.github_actions" | "action.label" | "action.merge" | "action.post_check" | "action.queue.batch_bisection_end" | "action.queue.batch_bisection_start" | "action.queue.change" | "action.queue.checks.change" | "action.queue.checks_end" | "action.queue.checks_not_started" | "action.queue.checks_start" | "action.queue.enter" | "action.queue.leave" | "action.queue.merged" | "action.rebase" | "action.refresh" | "action.request_reviews" | "action.requeue" | "action.review" | "action.squash" | "action.unqueue" | "action.update" | "ci_issue.created" | "ci_issue.linked" | "ci_issue.merged" | "ci_issue.renamed" | "ci_issue.reopened" | "ci_issue.resolved" | "ci_issue.unresolved" | "command.dequeue" | "command.queue" | "command.requeue" | "queue.pause.create" | "queue.pause.delete" | "queue.pause.update" | "scheduled_freeze.create" | "scheduled_freeze.delete" | "scheduled_freeze.update"[]

The specific types of events to select

received_from string <date-time>

Get the events received from this date

received_to string <date-time>

Get the events received until this date

cursor string

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

per_page integer

The number of items per page

min: 1 · max: 100

Responses
200 Successful Response
sizeintegerrequired

The number of items in this page

per_pageintegerrequired

The number of items per page

eventsobject (37 types)[]required

The list of events

Discriminated by type — 37 types
action.assignEventAssign
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventAssignMetadatarequired
addedstring[]required
removedstring[]required
action.backportEventBackport
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventCopyMetadatarequired
tostringrequired
pull_request_numberintegerrequired
conflictsbooleanrequired
action.closeEventClose
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventCloseMetadatarequired
messagestringrequired
action.commentEventComment
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventCommentMetadatarequired
messagestringrequired
action.copyEventCopy
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
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
typestringrequired
metadataEventDeleteHeadBranchMetadatarequired
branchstringrequired
action.dismiss_reviewsEventDismissReviews
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventDismissReviewsMetadatarequired
usersstring[]required
action.editEventEdit
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventEditMetadatarequired
draftbooleanrequired
action.github_actionsEventGithubActions
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventGithubActionsMetadatarequired
workflowstringrequired
inputsobjectrequired
action.labelEventLabel
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventLabelMetadatarequired
addedstring[]required
removedstring[]required
action.mergeEventMerge
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventMergeMetadatarequired
branchstringrequired
action.post_checkEventPostCheck
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventPostCheckMetadatarequired
conclusionstringrequired
titlestringrequired
summarystringrequired
action.queue.batch_bisection_endEventQueueBatchBisectionEnd
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueBatchBisectionEndMetadatarequired
queue_namestringrequired
partition_namestringrequired
priority_rule_namestring | nullrequired
original_batch_pr_numbersinteger[]required
culprit_foundbooleanrequired
culprit_pr_numbersinteger[]required
remaining_pr_numbersinteger[]required
max_failure_resolution_reachedbooleanrequired
action.queue.batch_bisection_startEventQueueBatchBisectionStart
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueBatchBisectionStartMetadatarequired
queue_namestringrequired
partition_namestringrequired
priority_rule_namestring | nullrequired
original_batch_pr_numbersinteger[]required
batch_size_before_splitintegerrequired
number_of_sub_batchesintegerrequired
bisection_depthintegerrequired
is_top_levelbooleanrequired
action.queue.changeEventQueueChange
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueChangeMetadatarequired
queue_namestringrequired
partition_namestringrequired
priority_rule_namestring | nullrequired
sizeintegerrequired
action.queue.checks.changeEventQueueChecksChange
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueChecksChangeMetadatarequired
queue_namestringrequired
partition_namestringrequired
running_checksintegerrequired
action.queue.checks_endEventQueueChecksEnd
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueChecksEndMetadatarequired
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" | "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" | "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" | "INTERMEDIATE_RESULTS_SKIPPED" | "CHECKS_RETRIED" | nullrequired
abort_reasonstring | nullrequired
abort_status"DEFINITIVE" | "REEMBARKED"required
Enum: DEFINITIVE REEMBARKED
branchstringrequired
partition_namestringrequired
priority_rule_namestring | nullrequired
queue_namestringrequired
queued_atstring <date-time>required
speculative_check_pull_requestmergify_engine__signals__SpeculativeCheckPullRequestrequired
numberintegerrequired
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
unsuccessful_checksmergify_engine__queue__merge_train__checks__QueueCheck__Serialized[]required
pull_request_numbersinteger[]required
train_car_idstring <uuid> | nullrequired
session_idstring <uuid>required
action.queue.checks_not_startedEventQueueChecksNotStarted
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueChecksNotStartedMetadatarequired
branchstringrequired
partition_namestring | nullrequired
priority_rule_namestring | nullrequired
queue_namestringrequired
queued_atstring <date-time>required
reasonstringrequired
session_idstring <uuid>required
action.queue.checks_startEventQueueChecksStart
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueChecksStartMetadatarequired
branchstringrequired
partition_namestring | nullrequired
priority_rule_namestring | nullrequired
queue_namestringrequired
queued_atstring <date-time>required
start_reasonstringrequired
speculative_check_pull_requestmergify_engine__signals__SpeculativeCheckPullRequestrequired
numberintegerrequired
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
unsuccessful_checksmergify_engine__queue__merge_train__checks__QueueCheck__Serialized[]required
pull_request_numbersinteger[]required
train_car_idstring <uuid> | nullrequired
session_idstring <uuid>required
action.queue.enterEventQueueEnter
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueEnterMetadatarequired
queue_namestringrequired
branchstringrequired
queued_atstring <date-time>required
partition_namestring | nullrequired
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
typestringrequired
metadataEventQueueLeaveMetadatarequired
reasonstringrequired
mergedbooleanrequired
queue_namestringrequired
branchstringrequired
partition_namestringrequired
queued_atstring <date-time>required
seconds_waiting_for_scheduleintegerrequired
seconds_waiting_for_freezeintegerrequired
priority_rule_namestring | nullrequired
conditions_evaluationmergify_engine__rules__conditions__QueueConditionEvaluationResult__Serialized | nullrequired
matchbooleanrequired
labelstringrequired
is_label_user_inputbooleanrequired
descriptionstring | nullrequired
attribute_namestring | nullrequired
operatorstring | nullrequired
scheduleobject | nullrequired
subconditionsmergify_engine__rules__conditions__QueueConditionEvaluationResult__Serialized[]required
evaluationsmergify_engine__rules__conditions__QueueConditionEvaluationResult__Evaluation__Serialized[]required
checksmergify_engine__queue__merge_train__checks__QueueCheck__Serialized[]required
namestringrequired
descriptionstringrequired
urlstring | nullrequired
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
action.queue.mergedEventQueueMerged
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueueMergedMetadatarequired
branchstringrequired
partition_namesstring[]required
queue_namestringrequired
queued_atstring <date-time>required
priority_rule_namestring | nullrequired
session_idstring <uuid>required
action.rebaseEventRebase
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
metadataEventNoMetadatarequired
typestringrequired
action.refreshEventRefresh
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
metadataEventNoMetadatarequired
typestringrequired
action.request_reviewsEventRequestReviews
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventRequestReviewsMetadatarequired
reviewersstring[]required
team_reviewersstring[]required
action.reviewEventReview
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventReviewMetadatarequired
review_typestringrequired
reviewerstring | nullrequired
messagestring | nullrequired
action.squashEventSquash
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
metadataEventNoMetadatarequired
typestringrequired
action.unqueueEventUnqueue
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
metadataEventNoMetadatarequired
typestringrequired
action.updateEventUpdate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
metadataEventNoMetadatarequired
typestringrequired
command.dequeueEventCommandDequeue
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventCommandMetadatarequired
authorGitHubAccountrequired
loginstringrequired
idintegerrequired
type"User" | "Organization" | "Bot" | "Mannequin" | "Enterprise"required
Enum: User Organization Bot Mannequin Enterprise
comment_idintegerrequired
session_idstring <uuid> | nullrequired
command.queueEventCommandQueue
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventCommandMetadatarequired
authorGitHubAccountrequired
loginstringrequired
idintegerrequired
type"User" | "Organization" | "Bot" | "Mannequin" | "Enterprise"required
Enum: User Organization Bot Mannequin Enterprise
comment_idintegerrequired
session_idstring <uuid> | nullrequired
queue.pause.createEventQueuePauseCreate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueuePauseCreateMetadatarequired
reasonstringrequired
created_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
queue.pause.deleteEventQueuePauseDelete
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueuePauseDeleteMetadatarequired
deleted_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
queue.pause.updateEventQueuePauseUpdate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventQueuePauseUpdateMetadatarequired
reasonstringrequired
updated_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
scheduled_freeze.createEventScheduledFreezeCreate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventScheduledFreezeCreateMetadatarequired
scheduled_freeze_attributesScheduledFreezeEventLogAttributesrequired
reasonstringrequired
startstring <date-time>required
endstring <date-time> | nullrequired
timezonestringrequired
matching_conditionsMatchingConditionsDict-Output | string[]required
exclude_conditionsMatchingConditionsDict-Output | string[]required
created_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
created_atstring <date-time>required
scheduled_freeze.deleteEventScheduledFreezeDelete
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventScheduledFreezeDeleteMetadatarequired
scheduled_freeze_attributesScheduledFreezeEventLogAttributesrequired
reasonstringrequired
startstring <date-time>required
endstring <date-time> | nullrequired
timezonestringrequired
matching_conditionsMatchingConditionsDict-Output | string[]required
exclude_conditionsMatchingConditionsDict-Output | string[]required
reasonstringrequired
deleted_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
deleted_atstring <date-time>required
scheduled_freeze.updateEventScheduledFreezeUpdate
idintegerrequired
received_atstring <date-time>required
triggerstringrequired
repositorystringrequired
pull_requestinteger | nullrequired
base_refstring | nullrequired
typestringrequired
metadataEventScheduledFreezeUpdateMetadatarequired
scheduled_freeze_attributes_beforeScheduledFreezeEventLogAttributesrequired
reasonstringrequired
startstring <date-time>required
endstring <date-time> | nullrequired
timezonestringrequired
matching_conditionsMatchingConditionsDict-Output | string[]required
exclude_conditionsMatchingConditionsDict-Output | string[]required
scheduled_freeze_attributes_afterScheduledFreezeEventLogAttributesrequired
reasonstringrequired
startstring <date-time>required
endstring <date-time> | nullrequired
timezonestringrequired
matching_conditionsMatchingConditionsDict-Output | string[]required
exclude_conditionsMatchingConditionsDict-Output | string[]required
updated_byActorrequired
type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_atstring <date-time>required
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",
      "type": "action.assign",
      "metadata": {}
    }
  ]
}
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request 
curl -X GET "https://api.mergify.com/v1/repos/:owner/:repository/logs" \
  -H "Authorization: Bearer <token>"

Was this page helpful?