API Documentation

Reference docs for events ingestion, identity, and integration patterns.

MetrixNest API

Use this API to send product events, identify your users, and read synced traffic reports.

Base URL

Relative to your app domain:

  • POST /api/v1/events
  • POST /api/v2/events
  • POST /api/v2/events/batch
  • POST /api/v2/identify
  • POST /api/v2/alias
  • GET /api/v2/traffic_reports

Authentication

The write endpoints (events, identify, alias) use a bearer token (Events API key):

bash
Authorization: Bearer <YOUR_EVENTS_API_KEY>

You can create Events API keys from your product area.

The read endpoint (traffic_reports) uses a separate Reports API key. An Events API key cannot read reports, and a Reports API key cannot write events.

API versions

  • v1: canonical event ingestion only (strict allowlist of event types)
  • v2: custom events, batch ingestion, identity endpoints, and read-only traffic reports

Read next