API Introduction

Use the Faurya public API to read analytics data, inspect visitors, and send server-side conversion or revenue events.

Base URL

All endpoints use this base URL:

https://api.faurya.com

Authentication

All API requests require Bearer Token authentication.

Add your API key in the Authorization header:

Authorization: Bearer YOUR_FAURYA_API_KEY

Content type

Send JSON request bodies with:

Content-Type: application/json

Available endpoints

• Visitor: GET /api/v1/visitors/{faurya_visitor_id}
• Create a goal: POST /api/v1/goals
• Delete goals: DELETE /api/v1/goals
• Create a payment: POST /api/v1/payments
• Delete payments: DELETE /api/v1/payments
• Analytics overview: GET /api/v1/analytics/overview
• Analytics metadata: GET /api/v1/analytics/metadata
• Realtime analytics: GET /api/v1/analytics/realtime
• Realtime map: GET /api/v1/analytics/realtime/map
• Devices: GET /api/v1/analytics/devices
• Pages: GET /api/v1/analytics/pages
• Campaigns: GET /api/v1/analytics/campaigns
• Referrers: GET /api/v1/analytics/referrers
• Countries: GET /api/v1/analytics/countries
• Regions: GET /api/v1/analytics/regions
• Cities: GET /api/v1/analytics/cities
• Browsers: GET /api/v1/analytics/browsers
• Operating systems: GET /api/v1/analytics/operating-systems
• Hostnames: GET /api/v1/analytics/hostnames

GET /api/v1/analytics/timeseries and GET /api/v1/analytics/goals currently return 501 Not Implemented.

Common response behavior

• 200 OK: Request accepted and recorded.
• 400 Bad Request: Invalid payload (missing required fields, invalid field format, or bot visitor).
• 401 Unauthorized: Missing or invalid Bearer Token.
• 404 Not Found: Resource context missing (for example, creating a goal for a visitor with no prior pageviews).
• 429 Too Many Requests: Account event limit reached.
• 501 Not Implemented: Endpoint exists but is not implemented yet.
• 500 Internal Server Error: Unexpected server issue.

Field naming and validation notes

• Payments require a unique transaction_id.
• Goal and payment metadata must be a JSON object with a maximum of 10 primitive values.
• If available, always send faurya_visitor_id to improve attribution quality.

Best practices

• Send events server-side after the action is confirmed (successful checkout, confirmed signup, etc.).
• Retry safely on transient errors, but avoid duplicate sends for the same event.
• Log response status and payload in your backend for debugging.

Next steps

• Start with Create a goal to track non-payment conversions.
• Use Create a payment to attribute revenue from any payment provider.