Skip to main content
GET

Overview

After submitting a batch, use this endpoint to check its progress and retrieve results. Poll periodically until the top-level status changes to completed.

Path Parameters

string
required
The UUID returned from the Submit Batch endpoint.

Query Parameters

string
required
Your ProWebLook API key. Must match the key used to submit the batch.

Response

string
The batch UUID.
string
Overall batch status:
  • processing — Still running. Keep polling.
  • completed — All numbers have been processed. Stop polling.
integer
Total number of phone numbers in the batch.
integer
Number of phone numbers that have finished processing (success or failure).
integer
Number of phone numbers that encountered an error during processing.
integer
Number of phone numbers still awaiting processing. Calculated as total_numbers - completed - failed.
array
Array of result objects, one per phone number.

Polling Best Practices

Poll every 5–10 seconds for small batches (<100 numbers) and every 30–60 seconds for large batches (1,000 numbers). Avoid polling more frequently than every 2 seconds.
JavaScript polling loop