Get a summary of how many attempts were made and how many were converted.

get/v2/Attempts/Summary

Query parameters

VerifyServiceSidstring

Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.

DateCreatedAfterstring date-time

Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.

DateCreatedBeforestring date-time

Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.

Countrystring iso-country-code

Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.

Channel'sms' | 'call' | 'email' | 'whatsapp' | 'rbm'

Filter Verification Attempts considered on the summary aggregation by communication channel.

DestinationPrefixstring

Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.

Response

total_attemptsinteger

Total of attempts made according to the provided filters

total_convertedinteger

Total of attempts made that were confirmed by the end user, according to the provided filters.

total_unconvertedinteger

Total of attempts made that were not confirmed by the end user, according to the provided filters.

conversion_rate_percentagestring nullable

Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100.

urlstring uri nullable

Changes

Changed in 4 of the 52 revisions of this API.15

Jul 3, 2025v21548692e68041See the full diff
- ○
  added the new enum value rbm to the query request parameter Channel
  request-parameter-enum-value-added
May 13, 2025v2be79b7856dbd1See the full diff
- ▲
  the conversion_rate_percentage response's property type/format changed from number/ to string/ for status 200
  response-property-type-changed
Aug 26, 2024v2c6432fdfc1a23See the full diff
- ○
  the total_attempts response's property default value 0 was added for the status 200
  response-property-default-value-added
- ○
  the total_converted response's property default value 0 was added for the status 200
  response-property-default-value-added
- ○
  the total_unconverted response's property default value 0 was added for the status 200
  response-property-default-value-added
Aug 10, 2023v2fb6ded97d73f1See the full diff
- ○
  api tag VerifyV2VerificationAttemptsSummary added
  api-tag-added

Full history