ScrollStudio APIs

Complete API documentation for analytics tracking, contact forms, web audits, and more.

Admin Dashboard →

Authentication

API Key Authentication

Include your API key in the X-API-Key header for protected endpoints.

curl -H "X-API-Key: your_api_key" https://apis2.thescrollstudio.com/api/v1/analytics/stats

Analytics

Tracking

POST
/analytics/track Public
Track pageviews, events, and user interactions
GET
/a.js Public
Core analytics tracking script

Reports Auth Required

GET
/api/v1/analytics/overview
Get analytics overview with key metrics
GET
/api/v1/analytics/realtime
Real-time visitor data
GET
/api/v1/analytics/traffic-sources
Traffic source breakdown
GET
/api/v1/analytics/geography
Geographic distribution of visitors
GET
/api/v1/analytics/devices
Device and browser statistics

Contact Form

POST
/contact Public
Submit a contact form
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "phone": "+1234567890",
  "message": "Hello!",
  "site": "example.com",
  "to": "recipient@example.com"
}

Web Audits

Public API

POST
/api/v1/audit Public
Start a new web audit
GET
/api/v1/audit/:id Public
Get audit status
GET
/api/v1/audit/:id/report Public
Get basic audit report
GET
/api/v1/audit/:id/full Public
Get detailed audit report with all checks

Admin Endpoints Auth Required

Sites

GET
/api/v1/admin/sites
List all sites
POST
/api/v1/admin/sites
Create a new site

Groups

GET
/api/v1/admin/groups
List all groups with API keys
POST
/api/v1/admin/groups
Create a new group

Webhooks

GET
/api/v1/admin/webhooks
List webhooks
POST
/api/v1/admin/webhooks/:id/test
Test webhook delivery

Health Checks

GET
/health Public
Basic health check
GET
/health/ready Public
Readiness probe (checks database)
GET
/health/live Public
Liveness probe