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

GET /v2/Attempts/Summary

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.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VA[0-9a-fA-F]{32}$.

  • 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 and CALL

    Values are sms, call, email, or whatsapp.

  • 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.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • conversion_rate_percentage number | null

      Percentage of the confirmed messages over the total.

    • total_attempts integer | null

      Total of attempts made.

    • total_converted integer | null

      Total of attempts confirmed by the end user.

    • total_unconverted integer | null

      Total of attempts made that were not confirmed by the end user.

    • url string(uri) | null
GET /v2/Attempts/Summary
curl \
 --request GET 'https://verify.twilio.com/v2/Attempts/Summary' \
 --user "username:password"
Response examples (200)
{
  "conversion_rate_percentage": 42.0,
  "total_attempts": 42,
  "total_converted": 42,
  "total_unconverted": 42,
  "url": "https://example.com"
}