DebugBear Documentation

API

Getting started

To get started install the debugbear Node module and generate an API key. You'll also need to find the ID of the page you want to analyze.

Learn more.

Starting an analysis

Create a script.js file like this:

const { analyzePage } = require("debugbear");

analyzePage({
  pageId: 185
});

Then run DEBUGBEAR_API_KEY=... node script.js.

Additional options

The Node module supports the same arguments as the CLI, except for ngrokWebPort.

Example:

await analyzePage({
  pageId: 185,
  commitHash: "e2ba122",
  waitForResult: true
});

Need other API features?

Let us know and we'll work with you to build one.

---