Get a summary of how many attempts were made and how many were converted
TODO: Resource-level docs
Get a summary of how many attempts were made and how many were converted.
Query parameters
-
VerifyServiceSid string
Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
-
DateCreatedAfter string(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.
-
DateCreatedBefore string(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.
-
Country string(iso-country-code)
Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
-
Channel string
Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are
SMS
andCALL
Values are
sms
,call
,email
, orwhatsapp
. -
DestinationPrefix string
Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
curl \
-X GET https://verify.twilio.com/v2/Attempts/Summary \
--user "username:password"
{
"conversion_rate_percentage": 42.0,
"total_attempts": 42,
"total_converted": 42,
"total_unconverted": 42,
"url": "https://example.com"
}
{
"conversion_rate_percentage": 42.0,
"total_attempts": 42,
"total_converted": 42,
"total_unconverted": 42,
"url": "https://example.com"
}