API Endpoints

Complete reference for SEER API endpoints for script and pipeline monitoring

Base URL
All API requests use this base URL
https://seer.ansrstudio.com/api
Monitoring Endpoints
Track script execution and job status

POST /monitoring

Submit job execution status and metadata

curl -X POST https://seer.ansrstudio.com/api/monitoring \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline_name": "ETL Pipeline",
    "status": "success",
    "metadata": {
      "rows_processed": 1000,
      "duration_seconds": 45
    }
  }'

POST /runs

Create a new run record

{
  "pipeline_name": "Data Validation",
  "status": "running",
  "started_at": "2025-11-27T10:00:00Z"
}

PATCH /runs/:id

Update existing run status

{
  "status": "completed",
  "ended_at": "2025-11-27T10:15:00Z",
  "metadata": {
    "records_validated": 5000
  }
}
Heartbeat Endpoint
Send regular heartbeat signals

POST /heartbeat

Keep-alive signal for scheduled jobs

curl -X POST https://seer.ansrstudio.com/api/heartbeat \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline_name": "Scheduled ETL",
    "interval": 300
  }'

Important: Send heartbeats at regular intervals (e.g., every 5 minutes) to detect if a pipeline stops unexpectedly

Rate Limits
API usage constraints

All Plans: 100 requests per minute

Response Headers:

  • X-RateLimit-Limit: Total requests allowed
  • X-RateLimit-Remaining: Requests remaining
  • X-RateLimit-Reset: Time until limit resets
Response Codes
HTTP status codes and meanings
200 OKRequest successful
201 CreatedResource created successfully
400 Bad RequestInvalid request data
401 UnauthorizedInvalid or missing API key
429 Too Many RequestsRate limit exceeded
500 Server ErrorInternal server error