Skip to Content
SendlySendly
API ReferenceValidation

Retrieve a validation run

GET
/api/v1/validation-runs/{id}

How far a run has got and what it found. The counters are advanced by each batch in the same step that commits the rows they count, so they are a ledger rather than a cached estimate and may be branched on.

There is no total to divide by, deliberately: a list changes size while a run walks it, so a denominator captured when the run started would be wrong by the time you read it. A run is finished when status is completed or failed, never when a percentage reaches 100.

Requires the validation:read scope — View your email validation runs and their results.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string

Resource id.

Formatuuid

Response Body

The run

application/json
  1. response

One bulk validation run over a list.

id*string
list_id*string|null
status*string
Value in"pending""running""completed""failed"
processed_count*integer

Addresses checked so far. There is deliberately no total: a list changes size while a run walks it, so a denominator captured up front would be wrong by the time you read it.

deliverable_count*integer
undeliverable_count*integer
risky_count*integer
started_at*|
Formatdate-time
completed_at*|
Formatdate-time
failure_reason*|

Set only on failed. Prose for an operator; never parse it.

created_at*string
Formatdate-time
Example Request
curl -X GET 'https://api.sendly.now/api/v1/validation-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "string",  "list_id": "string",  "status": "pending",  "processed_count": 0,  "deliverable_count": 0,  "undeliverable_count": 0,  "risky_count": 0,  "started_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z",  "failure_reason": "string",  "created_at": "2019-08-24T14:15:22Z"}