API Docs | Nexus Analytics

Nexus Analytics REST API

The Nexus API provides programmatic access to pipeline telemetry, alerts, and lineage metadata. All endpoints return JSON and require an API key.

Base URL: https://api.nexusanalytics.io/v1

Authentication

Include your API key in the X-API-Key header. Keys can be generated in the Nexus console.

curl -X GET "https://api.nexusanalytics.io/v1/pipelines" \
  -H "X-API-Key: nxs_live_abc123def456" \
  -H "Content-Type: application/json"

📦 GET /pipelines

Retrieve all monitored pipelines with status, throughput and last event timestamp.

{
  "pipelines": [
    {
      "id": "pipe_1a2b3c",
      "name": "payment_events_stream",
      "status": "healthy",
      "throughput": "2.4k/s",
      "last_event": "2026-05-30T10:32:14Z"
    }
  ]
}

ifhnfhf

⚠️ POST /alerts

Create a custom anomaly alert rule for a specific pipeline.

curl -X POST https://api.nexusanalytics.io/v1/alerts \
  -H "X-API-Key: your_key" \
  -d '{
    "pipeline_id": "pipe_1a2b3c",
    "condition": "latency > 500ms",
    "action": "slack"
  }'

Response: {"alert_id": "alt_99q2", "status": "active"}

📈 GET /metrics/{pipeline_id}

Retrieve time-series metrics (latency, data volume, error rate) for a given pipeline over a time range.

curl "https://api.nexusanalytics.io/v1/metrics/pipe_1a2b3c?start=2026-05-29T00:00:00Z&end=2026-05-30T00:00:00Z" \
  -H "X-API-Key: your_key"

Python SDK example

from nexus import NexusClient

client = NexusClient(api_key="nxs_live_xxx")
pipelines = client.pipelines.list()
for p in pipelines:
    print(f"{p.name}: {p.status} - {p.throughput} events/sec")