Programmatic access to your review data, alerts, OpsScores, and benchmarks. Integrate OpsScaleIQ directly into your analytics stack, BI tools, or custom dashboards.
10,000 req/day
Generous daily rate limit, shared across all your API keys.
Bearer Token Auth
Secure SHA-256 hashed key authentication on every request.
JSON REST API
Standard JSON responses, cursor-based pagination, ISO 8601 dates.
cURL
curl -H "Authorization: Bearer osiq_live_your_key_here" \ https://opsscaleiq.com/api/v1/reviews?page=1
Node.js / fetch
const res = await fetch('https://opsscaleiq.com/api/v1/reviews', {
headers: { 'Authorization': 'Bearer osiq_live_your_key_here' },
})
const { data, meta } = await res.json()Python
import requests
resp = requests.get(
'https://opsscaleiq.com/api/v1/reviews',
headers={'Authorization': 'Bearer osiq_live_your_key_here'}
)
data = resp.json()The API enforces 10,000 requests per day per organization, rolling calendar-day window (UTC). When you hit the limit, requests return 429 Too Many Requests with the following headers:
X-RateLimit-Limit: 10000 X-RateLimit-Remaining: 0 X-RateLimit-Reset: 2024-01-16T00:00:00Z # UTC midnight
/api/v1/locationsList all locations with latest OpsScore
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | number | Page number (default: 1) |
| perPage | number | Items per page (default: 20, max: 100) |
/api/v1/reviewsList reviews with optional filters
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| locationId | string | Filter by location UUID |
| since | ISO 8601 | Reviews on or after this date |
| rating | 1–5 | Filter by star rating |
| source | GOOGLE|YELP|... | Review source platform |
| triageCategory | string | AI triage category keyword |
| page / perPage | number | Pagination |
/api/v1/ops-scoresOpsScore history per location
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| locationId | string | Required — location UUID |
| since | ISO 8601 | Records on or after this date |
| page / perPage | number | Pagination |
/api/v1/alertsActive and resolved alerts
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| locationId | string | Filter by location UUID |
| severity | 1|2|3 | Alert severity level |
| category | string | Triage category keyword |
| since | ISO 8601 | Alerts on or after this date |
/api/v1/benchmarksVertical benchmark aggregates for your industry
{
"data": [ ... ],
"meta": {
"page": 1,
"perPage": 20,
"total": 143,
"totalPages": 8
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or revoked API key"
}
}Generate your first API key from your Account Settings. Available on Growth and Enterprise plans.