Skip to content
Aropath logo
Documentation

Build and Understand Your Business Better On Aropath

Quick starts, API references, and SDKs for every language your team already uses.

REST API Reference

The Aropath REST API enables programmatic event tracking from backend services, extraction of AI-generated growth insights, and automated PDF report downloads.

Base Endpoint

https://api.aropath.com/v1

Authentication Header

Authorization: Bearer YOUR_API_KEY

EndpointMethodDescription
/v1/events/trackPOSTTrack custom conversion events, checkouts, and monetary transaction values.
/v1/insightsGETRetrieve prioritized growth checklist items and bottleneck score predictions.
/v1/reportsGETQuery and download automated PDF summary reports (weekly, monthly, quarterly, semi-yearly, yearly).
/v1/projects/invitePOSTGenerate a 7-day team member invitation code for shared project access.
POST

/v1/events/track

Submit backend conversion events. Payload includes event name, monetary transaction value, currency code, and item breakdown.

bash
curl -X POST https://api.aropath.com/v1/events/track \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "checkout_completed",
    "value": 79.00,
    "currency": "USD",
    "items_count": 2,
    "user_id": "usr_123456"
  }'

Response (200 OK)

json
{
  "success": true,
  "event_id": "evt_9988776655",
  "timestamp": "2026-08-15T21:30:00Z"
}

HTTP Status Codes & Rate Limits

The API enforces a rate limit of 1,000 requests per minute per project key.

200 OKRequest succeeded
400 Bad RequestInvalid payload JSON
401 UnauthorizedMissing/invalid API key
429 Rate LimitedExceeded 1,000 req/min

Ready to get started?