Validation

Retrieve a validation run

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.

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

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/validation-runs/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: validation:read)

Path parameters

idstring uuid required

Resource id.

Response

The run

completed_atstring date-time nullable required
created_atstring date-time required
deliverable_countinteger required
failure_reasonstring nullable required

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

idstring required
list_idstring nullable required
processed_countinteger required

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.

risky_countinteger required
started_atstring date-time nullable required
status'pending' | 'running' | 'completed' | 'failed' required
undeliverable_countinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.