v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-04-145745483.2 KB
VerifyV2VerificationAttemptsSummary

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

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

OK

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