Impact GateDocs

Guides

How to find who consumes your API before you change it

Four ways to find API consumers across repositories, from code search to runtime metrics, and what each one misses.

On this page

Four sources of consumer evidence#

Before you rename a field or retire an endpoint you need a list of callers. No single source has all of them, so combine these.

  1. Code search across repositories

    Search for the path and for client wrapper names. Fast, but it misses dynamic URLs and generated clients.

  2. Contract-to-code tracing

    Start from the changed OpenAPI path and follow calls into consumer code. Impact Gate does this for supported HTTP client patterns in JavaScript, TypeScript, and Java in the repositories you select.

  3. Runtime metrics

    Prometheus request counters or Datadog APM spans show which routes receive traffic. Caller identity appears only if your instrumentation records it.

  4. Ask the owners

    Mobile apps, partners, and scripts outside your repositories will not appear in any of the sources above.

How to read the result#

Callers found: plan the migration with their owners. No callers found: you know only that none turned up in the scope you searched. Unknown usage is not zero usage.

  • All repositories that might call the API are selected.
  • Runtime traffic for the route has been checked.
  • External consumers are listed and a migration window is agreed.
  • Every gap is noted in the pull request description.

Explore the documentation

↑↓ NavigateEnter Open guideSearch stays in your browser