RTDashboard API

The RTDashboard REST API gives Agency plan customers programmatic access to their revenue data, orders, AI insights, and forecasts. Use it to build custom dashboards, white-label client reports, or data pipelines.

Base URL: https://rtdashboard.com/api/v1

Format: JSON

Auth: Bearer JWT

Authentication

All authenticated endpoints require a JWT obtained from POST /api/v1/auth/login. Pass it in the Authorization header.

curl -X POST https://rtdashboard.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"secret"}'

# Response
{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_type": "bearer"
}

Include the token on every subsequent request:

curl https://rtdashboard.com/api/v1/overview?range=30d \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Tokens expire after 7 days. Store them securely and never expose them in client-side code or public repos.

Endpoints

Revenue & KPIs

GEThttps://rtdashboard.com/api/v1/overview🔒 JWT required

GEThttps://rtdashboard.com/api/v1/forecast🔒 JWT required

Orders

GEThttps://rtdashboard.com/api/v1/orders🔒 JWT required

AI Insights

GEThttps://rtdashboard.com/api/v1/insights🔒 JWT required

Stores

GEThttps://rtdashboard.com/api/v1/stores🔒 JWT required

Errors

All errors follow a consistent shape:

{ "detail": "Human-readable message", "code": "machine_readable_code" }

Status	Title	Description
400	Bad Request	Missing or invalid parameters.
401	Unauthorized	JWT is missing, expired, or invalid.
403	Forbidden	Your plan does not include this feature. Upgrade at /pricing.
404	Not Found	The requested resource does not exist.
429	Too Many Requests	Rate limit exceeded. See X-RateLimit-* headers.
500	Internal Server Error	Something went wrong on our end. Errors are automatically reported.

Rate limits

Requests are limited to 200 per minute per IP. Exceeded limits return HTTP 429. Inspect the response headers to track your usage:

X-RateLimit-Limit: 200
X-RateLimit-Remaining: 185
X-RateLimit-Reset: 1746310800

If you need higher limits for batch processing, contact us at api@rtdashboard.io.

Changelog

2025-05-01

v1.1

Added /forecast endpoint with 30 and 90-day horizons
Source breakdown now includes channel attribution

2025-03-15

v1.0

Initial API release with /overview, /orders, /insights, /stores