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

GET /v2/Attempts/Summary
Account sid auth token

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 ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.

  • DateCreatedBefore string(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.

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

    Values are sms, call, email, whatsapp, or rbm.

  • 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 headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • total_attempts integer

      Total of attempts made according to the provided filters

      Default value is 0.

    • total_converted integer

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

      Default value is 0.

    • total_unconverted integer

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

      Default value is 0.

    • conversion_rate_percentage string | null

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

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