VisitorPing Developer API & Webhooks

REST API & Webhooks Documentation

Integrate VisitorPing's real-time live visitor stream, traffic telemetry, and hot lead scoring into your custom dashboards, CRMs, or Zapier workflows.

Example Syntax:

1. Overview & Base URL

All API requests are served over HTTPS. JSON is returned in all responses.

https://app.visitorping.com/api/v1

GET

/api/v1/visitors/live

Returns all active website visitors who have interacted with your website within the last 5 minutes.

Request Example

curl -X GET "https://app.visitorping.com/api/v1/visitors/live?siteId=site_123" \
  -H "Authorization: Bearer vp_sec_live_xxxx"

JSON Response (200 OK)200 OK

{
  "status": "success",
  "count": 2,
  "visitors": [
    {
      "sessionId": "sess_10293847",
      "city": "Austin",
      "region": "Texas",
      "country": "US",
      "currentPage": "/pricing",
      "isHotLead": true,
      "hotReason": "Clicked phone link",
      "companyName": "Apple Inc."
    }
  ]
}

GET

/api/v1/stats

Retrieves aggregated session counts, unique visitors, and hot lead counts for today and historical ranges.

Request Example

curl -X GET "https://app.visitorping.com/api/v1/stats?siteId=site_123" \
  -H "Authorization: Bearer vp_sec_live_xxxx"

JSON Response (200 OK)200 OK

{
  "status": "success",
  "todaySessions": 142,
  "todayUniqueVisitors": 118,
  "todayHotLeads": 12,
  "activeNow": 4,
  "topLandingPage": "/pricing"
}

WEBHOOK

Real-Time Outgoing Webhooks

Configure Webhook endpoints in your VisitorPing Dashboard to receive POST payloads on visitor arrival or hot lead events.

Sample Webhook Payload

{
  "event": "visitor.hot_lead",
  "timestamp": "2026-08-13T18:40:12.000Z",
  "siteId": "site_9a8b7c",
  "visitor": {
    "sessionId": "sess_10293847",
    "location": {
      "city": "Austin",
      "region": "Texas",
      "country": "US"
    },
    "trafficSource": "Google Search (Organic)",
    "landingPage": "/pricing",
    "trigger": {
      "type": "PHONE_CLICK",
      "target": "tel:+15125550199",
      "detail": "Clicked primary emergency phone link"
    },
    "company": {
      "name": "Apple Inc.",
      "domain": "apple.com",
      "isEnterprise": true
    }
  }
}

{ "status": "success", "count": 2, "visitors": [ { "sessionId": "sess_10293847", "city": "Austin", "region": "Texas", "country": "US", "currentPage": "/pricing", "isHotLead": true, "hotReason": "Clicked phone link", "companyName": "Apple Inc." } ] }

{ "event": "visitor.hot_lead", "timestamp": "2026-08-13T18:40:12.000Z", "siteId": "site_9a8b7c", "visitor": { "sessionId": "sess_10293847", "location": { "city": "Austin", "region": "Texas", "country": "US" }, "trafficSource": "Google Search (Organic)", "landingPage": "/pricing", "trigger": { "type": "PHONE_CLICK", "target": "tel:+15125550199", "detail": "Clicked primary emergency phone link" }, "company": { "name": "Apple Inc.", "domain": "apple.com", "isEnterprise": true } } }