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

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

const volume = await nova.analytics.scoringVolume({ timeRange: "7d" });
{
  "period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "granularity": "minute",
  "data": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "total": 123,
      "completed": 123,
      "failed": 123
    }
  ]
}
Returns a time-series of scoring volume broken down by total, completed, and failed jobs. Granularity adjusts automatically based on the time range. 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

Granularity

Time rangeGranularity
1h1 minute
24h1 hour
7d1 day
30d1 day
90d1 day

Example response

{
  "period": {
    "start": "2026-03-01T00:00:00.000Z",
    "end": "2026-03-08T00:00:00.000Z"
  },
  "granularity": "day",
  "data": [
    {
      "timestamp": "2026-03-07T00:00:00.000Z",
      "total": 45,
      "completed": 40,
      "failed": 5
    },
    {
      "timestamp": "2026-03-08T00:00:00.000Z",
      "total": 55,
      "completed": 55,
      "failed": 0
    }
  ]
}

Response fields

FieldTypeDescription
period.startstringISO 8601 start of the period
period.endstringISO 8601 end of the period
granularitystringBucket size for each data point (minute, hour, or day)
data[].timestampstringISO 8601 timestamp for this bucket
data[].totalintegerCompleted + failed jobs in this bucket
data[].completedintegerJobs that completed successfully
data[].failedintegerJobs that failed
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

Scoring volume time series

period
object
required
granularity
enum<string>
required

Time bucket granularity

Available options:
minute,
hour,
day
data
object[]
required