Authentication
Product Analytics uses public API keys. Every request is scoped to the organization that owns the key.
Get an API key
- Click on API Keys in the Product Analytics dashboard menu.
- Copy the API key.
SDK authentication examples
Initialize your SDK once with the API key for the current environment:
import { altertable } from '@altertable/altertable-js';altertable.init('YOUR_API_KEY', {environment: 'production',});
Direct API authentication
For direct HTTP requests, use the same API key as your SDKs.
Method | How to send it | Notes |
|---|---|---|
X-API-Key header | X-API-Key: YOUR_API_KEY | Recommended for server-to-server requests. |
Authorization header | Authorization: Bearer YOUR_API_KEY | Equivalent to X-API-Key; useful when your client already uses Bearer auth patterns. |
Query parameter | ?apiKey=YOUR_API_KEY | Supported, but less preferred than headers because query strings are easier to leak into logs. |
Security guidance
- API keys are ingestion keys for product events and user identification. They cannot read historical analytics data or modify existing records.
- Prefer sending keys in headers. Use the query parameter form only when a header is not practical.
Next steps
- Track events: Start sending product events
- Identify users: Set up user identification