| Measurement |
Description |
Measurement Unit |
Interpretation |
| Checkrun |
Indicates the number of events of this type triggered when a check run was created, requested, rerequested and completed. |
Number |
The check runs API enables you to build GitHub Apps that run powerful checks against code changes in a repository. |
| Checksuite |
Indicates the number of events of this type triggered when a check suite was created, requested, rerequested and completed. |
Number |
A check suite is a collection of the check runs created by a single GitHub App for a specific commit. Check suites summarize the status and conclusion of the check runs that a suite includes. |
| Commit_comment |
Indicates the number of events of this type triggered when a commit comment was created. |
Number |
|
| Content_ref |
Indicates the number of events of this type triggered when the body or comment of an issue or pull request includes a URL that matches a configured content reference domain. |
Number |
These events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (https://subdomain.example.com) then only URLs for the subdomain trigger this event. If you register a domain (https://example.com) then URLs for domain and all subdomains trigger this event. |
| Create_evt |
Indicates the number of events of this type triggered when branches or tags were created. |
Number |
|
| Delete_evt |
Indicates the maximum number of collaborators who can access the repositories in the target user account. |
Number |
The value of this measure varies depending upon the type of GitHub account. For instance, if you're using GitHub Free account, you can add unlimited collaborators on public repositories, and up to three collaborators on private repositories owned by your personal account. |
| Deploy |
Indicates the number of events of this type triggered when new deployments were created. |
Number |
Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a deployment event that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). |
| Deploy_status |
Indicates the number of events of this type triggered when new deployments and deployment statuses were created. |
Number |
These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made. Deployment statuses allow external services to mark deployments with an error, failure, pending, in progress, queued, or success state that systems listening to deployment status events can consume. Deployment statuses can also include an optional description and log url, which are highly recommended because they make deployment statuses more useful. The log URL is the full URL to the deployment output, and the description is a high-level summary of what happened with the deployment. |
| Download |
Indicates the number of events of this type triggered when a new download was created. |
Number |
|
| Follow |
Indicates the number of events of this type triggered when a user follows another user. |
Number |
|
| Fork |
Indicates the number of events of this type triggered when a user forks a repository. |
Number |
A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. |
| Fork_apply |
Indicates the number of events of this type triggered when a patch was applied in the fork queue. |
Number |
|
| Github_app_auth |
Indicates the number of events of this type triggered when a user revoked his authorization of a GitHub App. |
Number |
Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this event, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the Bad Credentials error. |
| Gist |
Indicates the number of events of this type triggered when a Gist was created or updated. |
Number |
|
| Gollum |
Indicates the number of events of this type triggered when a Wiki page was created or updated. |
Number |
Gollum is a simple wiki system built on top of Git. A Gollum Wiki is simply a git repository of a specific nature:
A Gollum repository's contents are human-editable. Pages are unique text files which may be organized into directories any way you choose, as long as they have a recognized file extension. Other content can also be included, for example images, PDFs and headers/footers. Gollum pages:
May be written in a variety of markup languages. Can be edited with your favourite system editor or IDE or with the built-in web interface. Can be displayed in all versions, and can easily be rolled back.
Gollum supports advanced functionality like UML diagrams, macros, metadata, and more.
|
| Install |
Indicates the number of events of this type triggered when a user installed/uninstalled the GitHub App, or accepted new permissions for the GitHub App. |
Number |
|
| Install_repos |
Indicates the number of events of this type triggered when a repository was added or removed from an installation. |
Number |
|
| Issue_comment |
Indicates the number of events of this type triggered when an issue comment was created, edited or deleted. |
Number |
|
| Issues |
Indicates the number of events of this type triggered when an issue was opened, edited, deleted, transferred, pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled, locked, unlocked, milestoned or demilestoned. |
Number |
|
| Label |
Indicates the number of events of this type triggered when a repository's label was created, edited, or deleted. |
Number |
|
| Market_place_purchase |
Indicates the number of events of this type triggered when changes were happened to the a user's plan from the Marketplace purchase. |
Number |
These events are recorded when a user purchased a GitHub Marketplace plan, canceled the plan, upgraded the plan (effective immediately), downgraded the plan that remains pending until the end of the billing cycle, or cancels a pending plan. |
| Member |
Indicates the number of events of this type triggered when a user accepted an invitation or was removed as a collaborator to a repository, or had his/her permissions changed. |
Number |
|
| Membership |
Indicates the number of events of this type triggered when a user was added or removed from a team. |
Number |
|
| Milestone |
Indicates the number of events of this type triggered when a milestone was created, closed, opened, edited or deleted. |
Number |
The milestones are helpful to track progress on groups of issues or pull requests in a repository. When you create a milestone, you can associate it with issues and pull requests.
From the milestone page, you can see:
A user-provided description of the milestone, which can include information like a project overview, relevant teams, and projected due dates The milestone's due date The milestone's completion percentage The number of open and closed issues and pull requests associated with the milestone
Additionally, you can edit the milestone from the milestone page and create new issues that are, by default, associated with the milestone.
|
| Organization |
Indicates the number of events of this type triggered when an organization was deleted and renamed, and when a user was added, removed or invited to the organization. |
Number |
Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. |
| Org_block |
Indicates the number of events of this type triggered when an organization owner blocked or unblocked a user. |
Number |
|
| Page_build |
Indicates the number of events of this type triggered on push to a GitHub Pages enabled branch (gh-pages for project pages, master for user and organization pages). |
Number |
A PageBuild Events represents whether an attempted build of a GitHub Pages site is successful or not. |
| Project_card |
Indicates the number of events of this type triggered when a project card was created, edited, moved, converted to an issue, or deleted. |
Number |
|
| Project_column |
Indicates the number of events of this type triggered when a project column was created, updated, moved or deleted. |
Number |
|
| Project |
Indicates the number of events of this type triggered when a project was created, updated, closed, reopened or deleted. |
Number |
|
| Public_evt |
Indicates the number of events of this type triggered when a private repository was made public. |
Number |
|
| Pull_request |
Indicates the number of events of this type triggered when a pull request was assigned, unassigned, labeled, unlabeled, opened, edited, closed, reopened, synchronized, ready for review, locked, unlocked or when a pull request review was requested or removed. |
Number |
|
| PullReq_Review |
Indicates the number of events of this type triggered when a pull request review was submitted into a non-pending state, the body of the review was edited, or the review was dismissed. |
Number |
Reviews allow collaborators to comment on the changes proposed in pull requests, approve the changes, or request further changes before the pull request is merged. Repository administrators can require that all pull requests are approved before being merged. |
| PullReqRevComment |
Indicates the number of events of this type triggered when a comment on a pull request's unified diff was created, edited or deleted. |
Number |
|
| Push |
Indicates the number of events of this type triggered when repository branch pushes and repository tag pushes were performed. |
Number |
|
| Release |
Indicates the number of events of this type triggered when a release was published, unpublished, created, edited, deleted or prereleased. |
Number |
|
| Repository |
Indicates the number of events of this type triggered when a repository was created, archived, unarchived, renamed, edited, transferred, made public, or made private. |
Number |
|
| Repos_import |
Indicates the number of events of this type triggered when a successful, canceled, or failed repository import was finished for a GitHub organization or a personal repository. |
Number |
|
| ReposVulnerable_Alert |
Indicates the number of events of this type triggered when a security alert was created, dismissed or resolved. |
Number |
|
| Security_advisory |
Indicates the number of events of this type triggered when a new security advisory was published, updated or withdrawn. |
Number |
A security advisory provides information about security-related vulnerabilities in software on GitHub. Security Advisory webhooks are available to GitHub Apps only. The security advisory dataset also powers the GitHub security alerts. |
| Status |
Indicates the number of events of this type triggered when the status of a Git commit changed. |
Number |
|
| Team |
Indicates the number of events of this type triggered when an organization's team was created, deleted, edited, added to repository, or removed from repository. |
Number |
|
| TeamAdd |
Indicates the number of events of this type triggered when a repository was added to a team. |
Number |
|
| Watch |
Indicates the number of events of this type triggered when a user starred a repository. |
Number |
|