Валидация Email

Получить аналитику по задаче

Возвращает агрегированную статистику по задаче валидации: счётчики результатов, доставляемость и разбивку невалидных адресов по категориям причин.

Что включено:

  • total / good / bad / unknown — счётчики адресов по итоговому результату (validation_result).
  • deliverability — доля валидных адресов в процентах (good / total * 100), целое число 0–100.
  • reasons — разбивка невалидных (bad) адресов по категориям причин отклонения, отсортированная по убыванию количества.

Категории причин (reasons[].key): disposable (одноразовые/временные домены), catch_all, role (ролевые адреса), spam_trap (спам-ловушки/blackhole), syntax (синтаксис), no_mx (нет MX/недоступны), smtp_reject (отказ почтового сервера). Нераспознанные значения возвращаются как slug исходной причины либо other.

Безопасность: задача доступна только владельцу аккаунта, создавшему её.

get/api/v1/tasks/{taskId}/analytics

Request

  • Base URL: https://api.uchecker.net
  • URL: https://api.uchecker.net/api/v1/tasks/{taskId}/analytics
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

taskIdnumber required
Example:123

Числовой идентификатор задачи

Response

Агрегированная аналитика по задаче.

totalnumber required

Общее количество email-адресов в задаче

goodnumber required

Количество валидных адресов (good)

badnumber required

Количество адресов с вердиктом bad — достоверно невалидных.

unknownnumber required

Количество адресов, по которым доставляемость определить не удалось. Считается как total - good - bad, поэтому сюда попадают и адреса с вердиктом unknown, и ещё не проверенные на момент запроса. Три счётчика всегда дают total.

deliverabilitynumber required

Доставляемость: good / total * 100, округлённая до целого. Диапазон 0–100.

Example response

{
  "total": 100,
  "good": 80,
  "bad": 15,
  "unknown": 5,
  "deliverability": 80,
  "reasons": [
    {
      "key": "smtp_reject",
      "count": 12
    }
  ]
}

Changes

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