M
Metrics
Harshit Metrics
API Reference

API Overview

REST API overview for Harshit Metrics.

Base URL

https://metrics.harshit.page

Or your self-hosted domain.

Endpoints

MethodPathAuthDescription
POST/api/collectAPI KeyIngest events
GET/api/dashboardClerkGet dashboard analytics data
GET/api/projectsClerkList all projects
POST/api/projectsClerkCreate a new project
GET/api/projects/keysClerkList API keys for a project
POST/api/projects/keysClerkCreate a new API key

Authentication methods

The API uses two authentication methods depending on the endpoint:

API Key (for ingestion)

The /api/collect endpoint accepts an API key via:

  • x-api-key header (recommended)
  • apiKey query parameter (for sendBeacon fallback)

Clerk Auth (for management)

All other endpoints require a valid Clerk session. These are used by the dashboard UI.

Response format

All responses are JSON. Successful responses return the data directly. Error responses follow this format:

{
  "error": "Human-readable error message",
  "details": { /* validation details, if applicable */ }
}

CORS

The /api/collect endpoint supports CORS with:

  • Access-Control-Allow-Origin: *
  • Access-Control-Allow-Methods: POST, OPTIONS
  • Access-Control-Allow-Headers: content-type, x-api-key

API Reference

Complete method reference for the harshit-metrics SDK.

Authentication

How API keys and Clerk auth work in Harshit Metrics.

On this page

Base URLEndpointsAuthentication methodsAPI Key (for ingestion)Clerk Auth (for management)Response formatCORS