5-minute quick start: your first visitor report

This walkthrough takes you from zero to your website’s first visitor report: create a project, paste the snippet, click the floating ball.

Create a project

Sign in to the console → Integrations & collaboration → Team projects, and follow the three-step wizard:

1. Name the project (for example Checkout UAT)
2. Domain whitelist — the domains allowed to load the widget: exact (uat.example.com) or wildcard (*.example.com)
3. Route & widget — optionally bind an integration (Feishu Bitable / generic webhook), choose the ball’s default position, and decide whether anonymous visitors must leave contact details

Paste the embed code

Paste the embed code before </body> on every page where the ball should appear:

<script>
  window.BugCapturerConfig = {
    key: "bcpk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    position: "bottom-right",
    requireContact: false,
    reporter: { uid: "", name: "", email: "" } // fill per signed-in user, never hardcode one person
  };
</script>
<script src="https://api.bugcapturer.com/sdk/bugcapturer.js" async></script>

Done — the ball now appears on your site. Every field is documented in Configuration reference.

Click the ball like a visitor

1. The browser shows its native prompt: “allow www.xxx.com (your site’s domain) to view this tab?”
2. Click allow, and the SDK captures a screenshot of the current view
3. Then, inside the editor: annotate, crop, write a description…
4. Click Submit

Visitors who have the BugCapturer extension

When the SDK detects the extension, capture is delegated to it — pixel-accurate and with no permission prompt at all. Everyone else sees one browser confirmation per report.

See the report

• The report appears in the console under Feedback (SDK source, filterable by project)
• If an integration is bound, the row is delivered into your system automatically
• Technical context rides along: page URL (parameters masked), browser, OS, screen, console errors, failed requests

Common first-run situations

Symptom	Cause	What to do
The ball never appears	Wrong key / project paused / host not whitelisted	SDK & extension troubleshooting
Submit returns 403	The page’s host is not allowed	Add the exact host (or a one-level wildcard) to the whitelist
Submit returns 429	Daily limit reached (Free: 30/day/project, 10/day/IP)	Wait, or upgrade your plan
The visitor cancelled the prompt	Screen share declined	The report is submitted without a screenshot