🔑 API - Comming Soon

Developer API Access Your Visitor Data 💻

Access your visitor tracking data programmatically with our REST API. Build custom integrations, automate workflows, and sync data with your systems.

<100ms
Response Time
99.9%
Uptime
Get API Keys
JSON responses
API keys
Full documentation
API v1
GET
GET /api/v1/visitors
Response Example
200 OK
{
  "status": "success",
  "data": {
    "visitors": [
      {
        "id": "vis_123456",
        "ip_address": "192.168.1.100",
        "city": "New York",
        "country": "United States",
        "company": "TechCorp Solutions",
        "visit_time": "2024-01-15T10:30:00Z",
        "duration": 845,
        "pages_viewed": 8
      }
    ],
    "pagination": {
      "total": 1245,
      "per_page": 50,
      "current_page": 1
    }
  }
}

View Documentation

Quick Start Guide

Our API is currently in development, but you’ll soon be able to get started. Stay tuned for updates!

1

Get API Keys

Generate your API keys from the dashboard. Each key has specific permissions and rate limits.

Go to API Settings
2

Make Your First Request

Use cURL or your favorite HTTP client to test the API with your key.

curl -X GET "https://api.WebInsight Traffic Intelligence/v1/visitors" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
3

Explore Endpoints

Check out available endpoints for visitors, domains, analytics, and more.

Visitors Domains Analytics
Visitors Domains Analytics Webhooks

Visitor Endpoints

Access and manage visitor data through these endpoints.

GET
/api/v1/visitors
Active

Retrieve a list of visitors with optional filtering and pagination.

Query Parameters

page
integer
optional
Page number for pagination
per_page
integer
optional
Items per page (max: 100)
domain_id
string
optional
Filter by domain ID
start_date
string
optional
Start date (YYYY-MM-DD)
end_date
string
optional
End date (YYYY-MM-DD)

Response

{
  "status": "success",
  "data": {
    "visitors": [
      {
        "id": "vis_123456",
        "domain_id": "dom_789",
        "ip_address": "192.168.1.100",
        "user_agent": "Mozilla/5.0...",
        "city": "New York",
        "region": "NY",
        "country": "United States",
        "company": "TechCorp Solutions",
        "visit_time": "2024-01-15T10:30:00Z",
        "duration": 845,
        "pages_viewed": 8,
        "landing_page": "/",
        "exit_page": "/contact",
        "device_type": "desktop",
        "browser": "Chrome",
        "os": "Windows"
      }
    ],
    "pagination": {
      "total": 1245,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 25
    }
  }
}
GET
/api/v1/visitors/{id}
Active

Retrieve detailed information about a specific visitor.

Path Parameters

id
string
required
Visitor ID

Domain Endpoints

Manage your tracked domains through the API.

GET
/api/v1/domains
Active

Retrieve a list of your domains with their tracking status.

POST
/api/v1/domains
Active

Add a new domain for tracking.

Request Body

{
  "name": "My Website",
  "url": "https://example.com",
  "timezone": "America/New_York"
}

Analytics Endpoints

Access aggregated analytics and statistics.

GET
/api/v1/analytics/summary
Active

Get summary analytics for a date range.

Query Parameters

domain_id
string
optional
Domain ID (default: all domains)
period
string
optional
today, yesterday, week, month, year

Response Example

{
  "status": "success",
  "data": {
    "total_visitors": 1245,
    "unique_visitors": 890,
    "page_views": 4567,
    "avg_duration": 245,
    "top_countries": [
      {"country": "United States", "visitors": 650},
      {"country": "United Kingdom", "visitors": 180},
      {"country": "Germany", "visitors": 95}
    ],
    "top_pages": [
      {"page": "/", "views": 1200},
      {"page": "/pricing", "views": 850},
      {"page": "/features", "views": 650}
    ]
  }
}

Webhooks (Coming Soon)

We're building webhook support to send real-time notifications when events occur.

Development

Real-time Event Notifications

Receive webhook notifications when visitors arrive, companies are identified, or specific pages are viewed.

Visitor arrival events
Company identification
Traffic spikes
Expected: Q2 2024

Authentication & Limits

Secure your API access and understand usage limits

API Keys

All requests require an API key passed in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Generate keys from your dashboard with specific permissions.

Rate Limits

API requests are limited to ensure service stability.

1000 requests/hour
10 requests/second

Higher limits available for enterprise plans.

Security

All API communications are encrypted with TLS 1.3.

  • HTTPS only
  • API key rotation
  • IP whitelisting
  • Request logging

SDKs & Libraries

Client libraries for popular programming languages (Coming Soon)

PHP

Official PHP client library with Composer support.

Planned

Python

Python package for easy integration with Django, Flask, etc.

Planned

JavaScript

Node.js and browser-compatible JavaScript library.

Planned

cURL Examples

Complete cURL examples for all endpoints available now.

Available

Need Help With API Integration?

Our developer documentation and support team are here to help you integrate successfully.

Get API Keys Generate keys in your dashboard
Technical Support Contact our developers
FAQ Common questions answered
<100ms
Avg. Response
99.9%
Uptime SLA
24h
Support Response

Frequently Asked Questions

Common questions about our API

How do I get API keys?

API keys are generated from your dashboard. Go to Settings → API Keys to create new keys. Each key can have different permissions and rate limits.

What data formats does the API support?

The API accepts and returns JSON format only. All requests should have Content-Type: application/json header.

Are there rate limits?

Yes, the API has rate limits to ensure service stability. Free plans have 1,000 requests per hour. Enterprise plans have higher limits available.

Can I export all my visitor data?

Yes, you can export all visitor data through the API. Use pagination to retrieve large datasets efficiently.

When will webhooks be available?

Webhooks are currently in development and expected to launch in Q2 2024. You can request early access from your dashboard.

Is the API GDPR compliant?

Yes, all data accessed through the API is GDPR compliant. You can request data deletion for specific visitors through the API.

Ready to Build With Our API?

Start integrating visitor data into your applications and workflows today.

Start Free Trial View API Dashboard
REST
API Available
JSON
Format
HTTPS
Secure