API Reference

Use this page as the source of truth for Convertmax event API endpoints and integration patterns.

API Endpoints

GET /

• Auth: Not required (public)
• Purpose: Health/welcome response
• Response: JSON welcome message

Example:

curl -X GET https://event.convertmax.io/

POST /v1/track/

• Auth: Required
• Auth options:
  • Authorization: Bearer <api_key>
  • ?key=<api_key> query parameter
• Purpose: Ingest tracking events
• Response: Empty JSON object {} on success

Example using Authorization header:

curl -X POST https://event.convertmax.io/v1/track/ \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "page_view",
    "visitor": "visitor_123",
    "session_id": "session_abc",
    "data": {
      "page": "https://example.com"
    }
  }'

Example using ?key=:

curl -X POST "https://event.convertmax.io/v1/track/?key=<api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "convert",
    "visitor": "visitor_123",
    "session_id": "session_abc",
    "data": {
      "page": "https://example.com/checkout/success"
    }
  }'

Related reference

• Event Tracking: supported event names, payload expectations, and implementation examples