API Overview

Introduction to the Vemetric API for programmatic access to your analytics data

Introduction

The Vemetric API provides programmatic access to your analytics data. Use it to build custom dashboards, automate reports, integrate analytics into your internal tools, or export data for further analysis.

Base URL

All API requests should be made to:

https://api.vemetric.com

API Versioning

The current API version is v1. All endpoints are prefixed with /v1/.

https://api.vemetric.com/v1/analytics/query

Rate Limiting

The API implements rate limiting to ensure fair usage and system stability:

• Limit: 100 requests per 60 seconds per project
• Window: 60 seconds (sliding window)

Rate limit information is included in response headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1709582400

Header	Description
X-RateLimit-Limit	Maximum number of requests allowed in the current window
X-RateLimit-Remaining	Number of requests remaining in the current window
X-RateLimit-Reset	Unix timestamp (in seconds) when the rate limit resets

When you exceed the rate limit, the API returns a 429 Too Many Requests status code.

Response Format

All API responses are in JSON format with appropriate HTTP status codes:

• 200 - Success
• 400 - Bad Request (validation errors)
• 401 - Unauthorized (invalid API key)
• 403 - Forbidden (plan limits exceeded)
• 429 - Rate Limit Exceeded
• 500 - Internal Server Error

Success Response

{
  "period": {
    "from": "2026-01-01T00:00:00Z",
    "to": "2026-01-31T23:59:59Z"
  },
  "data": [
    // ... response data
  ]
}

Error Response

Error responses follow a consistent structure:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": [
      {
        "field": "date_range.0",
        "message": "Start date must be before or equal to end date"
      }
    ]
  }
}

See the Errors page for a complete list of error codes.

OpenAPI Specification

The Vemetric API provides an OpenAPI 3.0 specification for easy integration with API clients and code generators:

https://api.vemetric.com/openapi.json

You can use this with tools like:

• Postman - Import the OpenAPI spec to test API endpoints
• Swagger UI - Interactive API documentation
• OpenAPI Generator - Generate client SDKs in various languages

Getting Help

If you need help with the API:

• Check the Authentication guide to get started
• Review specific endpoint documentation:
  • Analytics Query - Query analytics metrics
  • Projects - Get project information
• Report issues on GitHub
• Contact support at [e-mail]

Next Steps

Authentication

Learn how to authenticate API requests with API keys

Analytics Query

Query your analytics data with flexible filtering and grouping

Projects

Retrieve project information and configuration

Error Codes

Understand API error codes and how to handle them