PulseFlow API Checklist

This documentation is designed to be extremely easy to follow, even if you have no technical background.

### 🚀 Getting Started in 3 Steps

1. **Get your API Key**: Go to your PulseFlow Dashboard and click on **Settings** > **API Keys**. Click 'Generate New Key'.
2. **Authorize this Page**: Copy your new key (it starts with `pf_`), scroll up to the top of this page, and click the green **Authorize** button. Paste your key in the box and click Authorize.
3. **Test it out!**: You can now click on any of the endpoints below (like `/api/v1/overview`), click **'Try it out'**, and then click **'Execute'** to see your live website data instantly!

---

### 📚 What can I do here?
Every single chart, graph, and number you see on your main dashboard is powered by these exact API routes.

You can use these endpoints to:
* **Build custom dashboards** in tools like Notion, Retool, or Google Looker Studio.
* **Trigger custom code** when a user makes a payment or hits a specific goal.
* **Export your raw data** into your own database for advanced analysis.

If you ever get stuck, just reach out!

Behavioral Intent Scoring

PulseFlow uses a proprietary scoring engine (0-100) to categorize visitors based on their session behavior, identity traits, and engagement history.

High Intent
Visitor has viewed pricing, plans, or subscription pages.
Hot Lead
Non-customer who returned for multiple sessions after viewing pricing.
Window Shopper
Returning visitor with high activity who intentionally avoids pricing.
Power User
Exceptional activity volume (25+ events or 5+ visits).
Customer
Users who have successfully completed a payment or spent > $0.
Abandoned
Visitor started a checkout process but did not complete a payment.
Technical
Developers or researchers viewing docs, guides, or API reference.

Retrieve Top Browsers

GEThttps://api.pulseflow.app/api/v1/browsers

Returns a 30-day leaderboard of the most popular web browsers used by visitors.

Authentication

Most API endpoints require a bearer token in the Authorization header.

Authorization: Bearer pf_1234567890

Bypass Adblockers (Next.js Proxy)

To improve tracking accuracy by bypassing adblockers, you can proxy PulseFlow through your own domain using Next.js rewrites.

1. next.config.ts
const nextConfig = {
  async rewrites() {
    return [
      { source: "/p.js", destination: "https://api.pulseflow.app/p.js" },
      { source: "/api/p", destination: "https://api.pulseflow.app/api/p" },
    ];
  },
};
2. Update Script Tag
<script 
  src="/p.js" 
  data-api-key="pf_..." 
  data-api-url="/api/p"
  defer
></script>
Request Example
Node.js / Fetch
const response = await fetch(`https://api.pulseflow.app/api/v1/browsers`, {method: 'GET',headers: {'Authorization': 'Bearer pf_...','Content-Type': 'application/json'}});