PRODUCT DOCUMENTATION
Understand your
API changes.
Connect your workspace, review downstream impact, and follow the evidence behind every report.
START HERE
Your first Impact Gate report
From sign-in and repository setup to an automatic pull request report.
Follow the quickstart01
Welcome to Impact GateUnderstand your API dependencies and review the impact of a contract change before merging.Set up your first workspaceConnect GitHub, index your repositories, and review your first automatic report.Sign in and manage your accountUse Google or a passwordless email link, return to your workspace, and manage connected sign-in methods.Get started
02
Connect the GitHub AppInstall Impact Gate, verify organization access, and connect the intended installation to your workspace.Select and index repositoriesBuild a useful workspace by indexing API providers and the applications that consume them.Connect & index
03
Read pull request reportsInterpret the Impact Gate check, contract changes, consumer evidence, and coverage notes.Use the engineering overviewMonitor repository analysis and investigate the latest open pull request findings.Explore APIs and callersInspect discovered endpoints, request and response schemas, caller evidence, and contract change history.Explore the dependency graphFollow service relationships, inspect endpoint references, and export a workspace snapshot.Review deprecation candidatesAssess evidence, record a review for the current snapshot, and plan removals with service owners.Review changes
04
Configure your workspaceControl default-branch synchronization, PR comments, and retained analysis history.Supported contracts and coveragePrepare contracts for analysis and understand which evidence the current release can establish.Permissions and data handlingUnderstand workspace roles, repository scope, recorded evidence, and retention controls.Troubleshoot common issuesResolve sign-in failures, missing repositories, partial indexing, and missing or outdated PR reports.Workspace web API referenceUnderstand the versioned endpoints used by the authenticated Impact Gate website.