API Reference
Introduction
Simple integration with your systems.
This project is currently in version 0.x. We reserve the right to make breaking changes to the API in this early access. Any breaking changes will follow Semver standards and occur only during minor releases.
This guide provides a quick overview of the available API endpoints, enabling you to integrate our analytics easily into your personal or professional dashboards to monitor website performance.
Our frontend Single Page Application (SPA) is built using the same API, serving as a practical reference for your implementation. Additionally, each analytics instance hosts an openapi.yaml file at /openapi.yaml for easy integration with your own OpenAPI clients.
Authentication
To access the API, all requests (except Event) must include a cookie named _me_sess, which you can obtain from the /auth/login endpoint.
Errors
| Code | Description |
|---|---|
| 400 | Bad Request - Ensure the request is correctly formatted. |
| 401 | Unauthorized - Ensure you are authenticated. |
| 403 | Forbidden - Ensure you have the correct permissions to view the page. |
| 404 | Not Found - Ensure the resource exists. |
| 409 | Conflict - The resource already exists. |
| 429 | Too Many Requests - You have exceeded the rate limit. |
| 500 | Internal Server Error - This is an unhandled bug on our end. Please report it by creating an issue. |