Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-145344123.3 KB

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 RFC 2822 format.

DateCreatedBeforestring date-time

Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in RFC 2822 format.

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'

Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are SMS and CALL

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

conversion_rate_percentagenumber nullable

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

total_attemptsinteger nullable

Total of attempts made according to the provided filters

total_convertedinteger nullable

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

total_unconvertedinteger nullable

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

urlstring uri nullable