Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Analytics
Analytics - Performance

Get Batch Diagnostics

Get comprehensive diagnostics for a batch.

Combines batch status, task progress, collection info, performance metrics, and actionable insights into a single response for easy frontend rendering.

Use Cases:

  • Monitor batch processing in real-time
  • Debug failed batches
  • View performance breakdown after completion
  • Get actionable next steps

Response includes:

  • Overall batch status and progress
  • Per-tier task details with Ray job links
  • Collection document counts
  • Performance insights and bottlenecks (if completed)
  • Error details (if failed)
  • Recommended next actions

Example:

GET /v1/analytics/performance/batches/{batch_id}/diagnostics

Perfect for:

  • Real-time progress tracking UI
  • Batch monitoring dashboards
  • Debugging failed extractions
  • Performance optimization
get/v1/analytics/performance/batches/{batch_id}/diagnostics

Path parameters

batch_idstring required

Response

Successful Response

batch_idstring required

Batch ID

batch_namestring required

Batch name

statusstring required

Overall batch status

bucket_idstring required

Source bucket ID

current_tierinteger

Current tier being processed

total_tiersinteger

Total number of tiers

overall_progressnumber

Overall progress percentage (0-100)

created_atstring date-time nullable

When batch was created

submitted_atstring date-time nullable

When batch was submitted

started_atstring date-time nullable

When processing started

completed_atstring date-time nullable

When processing completed

duration_secondsnumber nullable

Total duration in seconds

estimated_completionstring date-time nullable

Estimated completion time

performance_summaryobject nullable

Performance metrics summary (available after completion)

has_failuresboolean

Whether batch has any failures

failed_tier_countinteger

Number of failed tiers

healthstring

Derived health signal: 'ok', 'scaling' (PROCESSING with no progress yet but still inside the GPU cold-start / cluster-provisioning window — a scale-from-zero node and image pull can take ~20 min, so this is expected, not stuck), 'stuck' (PROCESSING but no progress and the active tier's job has been PENDING past the cold-start window — its driver/worker may be unschedulable), or 'degraded' (has partial failures).

blocked_reasonstring nullable

Human-readable reason the batch appears stuck/blocked, or — for health='scaling' — why it is legitimately waiting (e.g. 'cluster_cold_start: GPU workers scaling from zero'). None when health is 'ok' or 'degraded'.

stuck_secondsnumber nullable

How long the batch has been making no progress while PROCESSING, in seconds. None when not stuck.

total_objectsinteger

Total objects in batch

next_actionsstring[]

Recommended next steps for user