API ReferenceOverview

API Overview Admin

The Nucleus API provides programmatic access to your analytics data.

Base URL

https://api.nucleusanalytica.com

All endpoints are relative to this base URL.

Authentication

Every request must include an Authorization header:

Authorization: Bearer <token>

Two types of tokens are accepted:

  • JWT token — obtained from the login flow. Expires after 7 days.
  • API key — created in Settings > API Keys. Does not expire until deleted.

See Authentication for details.

Rate Limits

ScopeLimit
Per API key1,000 requests per hour
Per user (JWT)1,000 requests per hour

If you exceed the limit, you receive a 429 Too Many Requests response. Wait before retrying.

Response Format

All responses are JSON. Successful responses return the data directly:

{
  "data": [...],
  "meta": {
    "total": 1500,
    "page": 1,
    "per_page": 100
  }
}

Error responses include an error message:

{
  "error": "Invalid date range"
}

See Error Codes for the full list of HTTP status codes.

The API is intended for data export and integration. For interactive data exploration, use the Nucleus web interface and AI chat.