Skip to main content
GET
/
v1
/
score
/
batch
/
{batchId}
cURL
curl --request GET \
  --url https://embed.nova.dweet.com/v1/score/batch/{batchId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-Id: <x-tenant-id>'
{
  "batchId": "batch_abc123def456",
  "status": "processing",
  "jobId": "job-123",
  "totalJobs": 50,
  "completed": 35,
  "failed": 2,
  "processing": 13,
  "jobs": [
    {
      "applicationId": "app-001",
      "scoringJobId": "sj_abc123",
      "status": "completed"
    },
    {
      "applicationId": "app-002",
      "scoringJobId": "sj_def456",
      "status": "processing"
    }
  ]
}
Check the progress and status of a batch scoring submission.

​
When to Use

  • Monitor progress of large batch submissions
  • Detect when a batch has completed
  • Identify failed jobs within a batch

​
Status Values

StatusDescription
processingBatch has jobs still in progress
completedAll jobs in the batch have finished (either completed or failed)

​
Progress Tracking

The response includes counters for tracking progress: 
{
  "batchId": "batch_abc123",
  "status": "processing",
  "totalJobs": 50,
  "completed": 35,
  "failed": 2,
  "processing": 13
}

​
Individual Job Status

The jobs array shows the status of each job in the batch: 
{
  "jobs": [
    { "applicationId": "app-001", "scoringJobId": "sj_abc123", "status": "completed" },
    { "applicationId": "app-002", "scoringJobId": "sj_def456", "status": "processing" },
    { "applicationId": "app-003", "scoringJobId": "sj_ghi789", "status": "failed" }
  ]
}
Use the scoringJobId to fetch detailed results via Get Score by Scoring Job ID.

​
Polling Recommendation

For real-time updates, use webhooks instead of polling. Each job in the batch triggers individual webhook events when completed.
If polling, wait at least 5 seconds between requests to avoid unnecessary load.

Authorizations

​
Authorization
string
header
required

API key authentication. Use your environment-specific API key (sk_test_* for sandbox, sk_live_* for production).

Headers

​
X-Tenant-Id
string
required

Your customer/tenant identifier. Used for data isolation and per-customer metrics. Tenants are created automatically on first request.

Path Parameters

​
batchId
string
required

The batch ID returned from POST /v1/score/batch

Response

Batch status retrieved

​
batchId
string
required

Unique identifier for this batch

​
status
enum<string>
required

Overall batch status

Available options:
processing,
completed
​
jobId
string
required

The job ID all candidates were scored against

​
totalJobs
integer
required

Total number of scoring jobs in the batch

​
completed
integer
required

Number of jobs that completed successfully

​
failed
integer
required

Number of jobs that failed

​
processing
integer
required

Number of jobs still processing

​
jobs
object[]

Status of individual jobs in the batch

​
completedAt
string<date-time>

When the batch completed (only present when status is 'completed')