github.com/twilio/twilio-go@v1.20.1/rest/flex/v1/docs/InsightsQualityManagementAssessmentsApi.md (about)

     1  # InsightsQualityManagementAssessmentsApi
     2  
     3  All URIs are relative to *https://flex-api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateInsightsAssessments**](InsightsQualityManagementAssessmentsApi.md#CreateInsightsAssessments) | **Post** /v1/Insights/QualityManagement/Assessments | 
     8  [**ListInsightsAssessments**](InsightsQualityManagementAssessmentsApi.md#ListInsightsAssessments) | **Get** /v1/Insights/QualityManagement/Assessments | 
     9  [**UpdateInsightsAssessments**](InsightsQualityManagementAssessmentsApi.md#UpdateInsightsAssessments) | **Post** /v1/Insights/QualityManagement/Assessments/{AssessmentSid} | 
    10  
    11  
    12  
    13  ## CreateInsightsAssessments
    14  
    15  > FlexV1InsightsAssessments CreateInsightsAssessments(ctx, optional)
    16  
    17  
    18  
    19  Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question.
    20  
    21  ### Path Parameters
    22  
    23  This endpoint does not need any path parameter.
    24  
    25  ### Other Parameters
    26  
    27  Other parameters are passed through a pointer to a CreateInsightsAssessmentsParams struct
    28  
    29  
    30  Name | Type | Description
    31  ------------- | ------------- | -------------
    32  **Authorization** | **string** | The Authorization HTTP request header
    33  **CategorySid** | **string** | The SID of the category 
    34  **CategoryName** | **string** | The name of the category
    35  **SegmentId** | **string** | Segment Id of the conversation
    36  **AgentId** | **string** | The id of the Agent
    37  **Offset** | **float32** | The offset of the conversation.
    38  **MetricId** | **string** | The question SID selected for assessment
    39  **MetricName** | **string** | The question name of the assessment
    40  **AnswerText** | **string** | The answer text selected by user
    41  **AnswerId** | **string** | The id of the answer selected by user
    42  **QuestionnaireSid** | **string** | Questionnaire SID of the associated question
    43  
    44  ### Return type
    45  
    46  [**FlexV1InsightsAssessments**](FlexV1InsightsAssessments.md)
    47  
    48  ### Authorization
    49  
    50  [accountSid_authToken](../README.md#accountSid_authToken)
    51  
    52  ### HTTP request headers
    53  
    54  - **Content-Type**: application/x-www-form-urlencoded
    55  - **Accept**: application/json
    56  
    57  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    58  [[Back to Model list]](../README.md#documentation-for-models)
    59  [[Back to README]](../README.md)
    60  
    61  
    62  ## ListInsightsAssessments
    63  
    64  > []FlexV1InsightsAssessments ListInsightsAssessments(ctx, optional)
    65  
    66  
    67  
    68  Get assessments done for a conversation by logged in user
    69  
    70  ### Path Parameters
    71  
    72  This endpoint does not need any path parameter.
    73  
    74  ### Other Parameters
    75  
    76  Other parameters are passed through a pointer to a ListInsightsAssessmentsParams struct
    77  
    78  
    79  Name | Type | Description
    80  ------------- | ------------- | -------------
    81  **Authorization** | **string** | The Authorization HTTP request header
    82  **SegmentId** | **string** | The id of the segment.
    83  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    84  **Limit** | **int** | Max number of records to return.
    85  
    86  ### Return type
    87  
    88  [**[]FlexV1InsightsAssessments**](FlexV1InsightsAssessments.md)
    89  
    90  ### Authorization
    91  
    92  [accountSid_authToken](../README.md#accountSid_authToken)
    93  
    94  ### HTTP request headers
    95  
    96  - **Content-Type**: Not defined
    97  - **Accept**: application/json
    98  
    99  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   100  [[Back to Model list]](../README.md#documentation-for-models)
   101  [[Back to README]](../README.md)
   102  
   103  
   104  ## UpdateInsightsAssessments
   105  
   106  > FlexV1InsightsAssessments UpdateInsightsAssessments(ctx, AssessmentSidoptional)
   107  
   108  
   109  
   110  Update a specific Assessment assessed earlier
   111  
   112  ### Path Parameters
   113  
   114  
   115  Name | Type | Description
   116  ------------- | ------------- | -------------
   117  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   118  **AssessmentSid** | **string** | The SID of the assessment to be modified
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a UpdateInsightsAssessmentsParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  **Authorization** | **string** | The Authorization HTTP request header
   128  **Offset** | **float32** | The offset of the conversation
   129  **AnswerText** | **string** | The answer text selected by user
   130  **AnswerId** | **string** | The id of the answer selected by user
   131  
   132  ### Return type
   133  
   134  [**FlexV1InsightsAssessments**](FlexV1InsightsAssessments.md)
   135  
   136  ### Authorization
   137  
   138  [accountSid_authToken](../README.md#accountSid_authToken)
   139  
   140  ### HTTP request headers
   141  
   142  - **Content-Type**: application/x-www-form-urlencoded
   143  - **Accept**: application/json
   144  
   145  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   146  [[Back to Model list]](../README.md#documentation-for-models)
   147  [[Back to README]](../README.md)
   148