Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListContactEvaluations

Lists contact evaluations in the specified Amazon Connect instance.

Request Syntax


GET /contact-evaluations/InstanceId?contactId=ContactId&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ContactId

The identifier of the contact in this instance of Amazon Connect.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Important

This is not expected to be set because the value returned in the previous response is always null.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EvaluationSummaryList": [ 
      { 
         "CreatedTime": number,
         "EvaluationArn": "string",
         "EvaluationFormId": "string",
         "EvaluationFormTitle": "string",
         "EvaluationId": "string",
         "EvaluatorArn": "string",
         "LastModifiedTime": number,
         "Score": { 
            "AutomaticFail": boolean,
            "NotApplicable": boolean,
            "Percentage": number
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EvaluationSummaryList

Provides details about a list of contact evaluations belonging to an instance.

Type: Array of EvaluationSummary objects

NextToken

If there are additional results, this is the token for the next set of results.

Important

This is always returned as null in the response.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Example

The following example lists the contact evaluations for a contact.

Sample Request


{
   "InstanceId": "[instance_id]",
   "ContactId": "[contact_id]"
}

Sample Response


{
   "EvaluationSummaryList": [
      {
         "EvaluationId": "[evaluation_id]",
         "EvaluationArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/contact-evaluation/[evaluation_id]",
         "EvaluationFormTitle": "form-title",
         "EvaluationFormId": "[evaluation_form_id]",
         "Status": "DRAFT",
         "EvaluatorArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/agent/arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "CreatedTime": "2023-05-04T01:16:29.693000-07:00",
         "LastModifiedTime": "2023-05-04T01:16:29.693000-07:00"
      },
   ]
}