API Reference

All API endpoints are served under /api/v1 and require authentication via the Authorization header unless otherwise noted.

Base URL

https://api.engagetrack.net/api/v1

Authentication

All API requests are authenticated using API keys. Pass the key as a Bearer token in the Authorization header:

curl -H "Authorization: Bearer et_live_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" \
  https://api.engagetrack.net/api/v1/organizations/{orgId}/sites

API keys provide scoped access to data endpoints (analytics, goals, funnels, annotations, visitors, sites). Create and manage keys in Settings > API Keys. See the Authentication guide for full details.

Response Format

All successful responses are wrapped in a standard envelope:

{
	"success": true,
	"data": { ... }
}

Error responses use:

{
	"error": "Error message"
}

Common Query Parameters

Most analytics endpoints accept these filters:

HTTP Status Codes

Rate Limiting

Endpoints are rate-limited per IP/user. Auth endpoints have stricter limits (5-50 req/window). Analytics endpoints are more generous. Responses include X-RateLimit-* headers.

Browse the sidebar to explore endpoints grouped by resource.