API Reference

Collection endpoints (/api/send, /api/batch) and /api/config/:websiteId are public so the tracker script and SDK can call them from end-user browsers. Protected X-Ray APIs are reserved for Hellyeah services and are not exposed to direct customer integrations.

Collect

Event ingestion. No auth required: the tracker script and client SDK call these directly from end-user browsers. Bot traffic is detected and dropped. Disabled trackers return 200 but discard the event.

• POST /api/send: Ingest a pageview, custom event, engagement update, or a single batch of events.
• POST /api/batch: Ingest a batch of events (tracker queue flush).
• GET /api/config/:websiteId: Tracker configuration for website initialization.

Sample request

POST /api/send
Content-Type: application/json

{
  "type": "event",
  "payload": {
    "website": "your-website-id",
    "hostname": "acme.com",
    "url": "/pricing",
    "referrer": "https://google.com",
    "name": "signup_click",
    "data": { "plan": "pro" }
  }
}

Sample response

{ "ok": true }