Skip to main content
GET
/
v1
/
analytics
/
overview
nova-embed
import { Nova } from "nova-embed";

const nova = new Nova({
  apiKey: "sk_test_...",
  tenantId: "acme-corp",
});

const overview = await nova.analytics.overview({ timeRange: "24h" });
{
  "period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "scoring": {
    "totalRequests": 123,
    "successRate": 123,
    "avgDurationMs": 123,
    "scoresGenerated": 123
  },
  "webhooks": {
    "deliveryRate": 123,
    "totalDeliveries": 123
  }
}
Returns a high-level summary of your scoring activity and webhook delivery for the given time range. Useful for building dashboards or periodic health checks. This endpoint requires only a valid API key. X-Tenant-Id isn’t required.

​
Query parameters

ParameterRequiredValuesDescription
timeRangeYes1h, 24h, 7d, 30d, 90dLookback window for the data

​
Example response

{
  "period": {
    "start": "2026-03-07T00:00:00.000Z",
    "end": "2026-03-08T00:00:00.000Z"
  },
  "scoring": {
    "totalRequests": 1420,
    "successRate": 0.97,
    "avgDurationMs": 1180,
    "scoresGenerated": 1378
  },
  "webhooks": {
    "deliveryRate": 0.99,
    "totalDeliveries": 2756
  }
}

​
Response fields

FieldTypeDescription
period.startstringISO 8601 start of the period
period.endstringISO 8601 end of the period
scoring.totalRequestsintegerTotal scoring jobs submitted
scoring.successRatenumberFraction of jobs that completed successfully (0 to 1)
scoring.avgDurationMsnumber | nullAverage end-to-end scoring duration in milliseconds. null if no completed jobs
scoring.scoresGeneratedintegerTotal scores produced
webhooks.deliveryRatenumberFraction of webhooks delivered successfully (0 to 1)
webhooks.totalDeliveriesintegerTotal webhook delivery attempts
Responses are cached for 60 seconds (Cache-Control: private, max-age=60). This endpoint is rate-limited under the analytics bucket (20 req/s).

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer sk_test_* or Authorization: Bearer sk_live_*.

Query Parameters

​
timeRange
enum<string>
required

Time range for the analytics query Time range for analytics queries.

Available options:
1h,
24h,
7d,
30d,
90d

Response

Analytics overview

​
period
object
required
​
scoring
object
required
​
webhooks
object
required