github.com/twilio/twilio-go@v1.20.1/rest/verify/v2/docs/AttemptsSummaryApi.md (about)

     1  # AttemptsSummaryApi
     2  
     3  All URIs are relative to *https://verify.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchVerificationAttemptsSummary**](AttemptsSummaryApi.md#FetchVerificationAttemptsSummary) | **Get** /v2/Attempts/Summary | 
     8  
     9  
    10  
    11  ## FetchVerificationAttemptsSummary
    12  
    13  > VerifyV2VerificationAttemptsSummary FetchVerificationAttemptsSummary(ctx, optional)
    14  
    15  
    16  
    17  Get a summary of how many attempts were made and how many were converted.
    18  
    19  ### Path Parameters
    20  
    21  This endpoint does not need any path parameter.
    22  
    23  ### Other Parameters
    24  
    25  Other parameters are passed through a pointer to a FetchVerificationAttemptsSummaryParams struct
    26  
    27  
    28  Name | Type | Description
    29  ------------- | ------------- | -------------
    30  **VerifyServiceSid** | **string** | Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
    31  **DateCreatedAfter** | **time.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.
    32  **DateCreatedBefore** | **time.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.
    33  **Country** | **string** | Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
    34  **Channel** | **string** | Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
    35  **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.
    36  
    37  ### Return type
    38  
    39  [**VerifyV2VerificationAttemptsSummary**](VerifyV2VerificationAttemptsSummary.md)
    40  
    41  ### Authorization
    42  
    43  [accountSid_authToken](../README.md#accountSid_authToken)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: Not defined
    48  - **Accept**: application/json
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53