Skip to main content

API Overview

The Ovyxa API provides programmatic access to your analytics data, enabling you to build custom dashboards, integrate with third-party tools, and automate reporting workflows. Our API is designed with simplicity and privacy-first principles at its core.

Base URL​

All API requests should be made to:

https://api.ovyxa.com/api/v1

Authentication​

Ovyxa supports two authentication methods:

  • JWT Tokens: For user session-based access (web applications, dashboards)
  • API Keys: For programmatic access (scripts, integrations, server-side applications)

All authenticated requests must include an Authorization header:

Authorization: Bearer YOUR_TOKEN_OR_API_KEY

See the Authentication page for detailed implementation guides.

Rate Limiting​

API requests are rate-limited to ensure fair usage and system stability:

  • Free tier: 1,000 requests per hour
  • Pro tier: 5,000 requests per hour
  • Enterprise tier: Custom limits

When you exceed the rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating when you can retry.

Response Format​

All API responses are returned in JSON format with consistent structure:

Success Response (200 OK):

{
  "data": {
    "metrics": { ... },
    "timeseries": [ ... ]
  },
  "meta": {
    "sampled": false,
    "filtered_bot_traffic": 127
  }
}

Error Response (4xx/5xx):

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required parameter: site_id"
  }
}

CORS Support​

CORS is enabled for all API endpoints, allowing you to make requests directly from browser-based applications. All origins are supported for authenticated requests.

Data Freshness​

Analytics data is typically available within 5 minutes of collection. The API returns near real-time data with minimal latency, ensuring your dashboards and integrations stay up-to-date.

Common Parameters​

Many endpoints share common query parameters:

  • site_id (required): The unique identifier for your site
  • date_from (required): Start date in YYYY-MM-DD format
  • date_to (required): End date in YYYY-MM-DD format
  • timezone (optional): IANA timezone (defaults to site timezone)
  • compare (optional): Enable comparison mode (true/false)

Use Cases​

The Ovyxa API enables powerful workflows:

  • Custom Dashboards: Build tailored analytics views for stakeholders
  • Automated Reports: Generate and email weekly/monthly reports
  • Data Integration: Export analytics to data warehouses or BI tools
  • Mobile Apps: Track events from native iOS/Android applications
  • Server-Side Tracking: Send events from backend processes
  • Multi-Platform Analytics: Consolidate data from web, mobile, and desktop apps

API Endpoints​

Ovyxa provides three main API categories:

  1. Stats API: Retrieve aggregated analytics data (13 endpoints)
  2. Events API: Send custom events and pageviews (2 endpoints)
  3. Authentication: Manage API access and tokens

Support​

Need help with the API? Contact our support team at support@ovyxa.com or join our community Discord for real-time assistance.