API Reference

The SeerStack API allows you to send events, identify users, and track behavior in your applications. All API requests require authentication using a Bearer token.

Base URL

All API requests should be made to:

https://api.seerstack.com

Authentication

Authenticate your requests by including your API key as a Bearer token in the Authorization header.

Authorization: Bearer sk_live_your_api_key

You can find your API key in the SeerStack Dashboard under Settings > Developer.

SDKs

We provide official SDKs for TypeScript and Ruby that handle authentication and provide a better developer experience.

npm install seerstack

gem install seerstack

Quick Examples

import Seerstack from 'seerstack';

const client = new Seerstack({
  apiKey: process.env['SEERSTACK_API_KEY'],
});

// Send an event
await client.events.capture({
  name: 'user.signup',
  user_id: 'user_123',
  data: { plan: 'pro' }
});

// Identify a user
await client.users.identify({
  user_id: 'user_123',
  email: 'user@example.com',
  name: 'Jane Doe'
});

Response Format

All successful responses return a JSON object with a success field:

{
  "success": true
}

Error responses include an error field with a human-readable message:

{
  "error": "Missing or invalid API key"
}

Rate Limits

The API allows up to 1,000 requests per minute per API key.