ListAutoEvaluations

ListAutoEvaluations gets a list of auto evaluations

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

ListAutoEvaluationsRequest is the request to get a list of auto evaluations.

completed_at

object (TimeFilter)

completed_at

optional

Optional, filter completed timestamp by a specific range

string <date-time>

optional

must match timestamp exactly

Examples:

1s1.000340012s

gte

string <date-time>

gte

optional

must be greater than or equal to timestamp

Examples:

1s1.000340012s

lte

string <date-time>

lte

optional

must be less than or equal to timestamp

Examples:

1s1.000340012s

string <date-time>

optional

must be greater than timestamp

Examples:

1s1.000340012s

string <date-time>

optional

must be less than timestamp

Examples:

1s1.000340012s

call_sid

object (CallSidFilter)

call_sid

optional

Optional - filter by call sid.

integer <int64> | string

optional

filter values must be non-zero to be applied Optional - filter by equal to.

gte

integer <int64> | string

gte

optional

Optional - filter by greater than or equal to.

lte

integer <int64> | string

lte

optional

Optional - filter by less than or equal to.

integer <int64> | string

optional

Optional - filter by greater than.

integer <int64> | string

optional

Optional - filter by less than.

any_of

array[integer <int64> | string]

any_of

optional

Optional - filter by any of the provided sids.

page_size

integer <int32>

page_size

optional

Optional - number of auto evaluations included in response.

order_by

string

order_by

optional

Optional. The order by which auto evaluations will be listed. Follows sql order by
syntax. When not provided the order defaults to "completed_at DESC".

page_token

string

page_token

optional

Optional. The next_page_token returned from a previous List request, if any.

risk_levels

array[string]

risk_levels

optional

Optional - filter by risk level.

Allowed values:

RISK_LEVEL_NONERISK_LEVEL_LOWRISK_LEVEL_MEDIUMRISK_LEVEL_HIGHRISK_LEVEL_RISK_FREE

channel_types

array[string]

channel_types

optional

Optional. Filter by channel type.

Allowed values:

CHANNEL_TYPE_EMAILCHANNEL_TYPE_SMSCHANNEL_TYPE_CHATCHANNEL_TYPE_VOICECHANNEL_TYPE_WHATSAPP

agent_user_ids

array[string]

agent_user_ids

optional

Optional - filter by agent user ids.

scorecard_ids

array[integer <int64> | string]

scorecard_ids

optional

Optional - filter by scorecard ids.

category_ids

array[integer <int64> | string]

category_ids

optional

Optional - filter by category ids.

Example

{
    "completed_at": {
        "eq": "1s",
        "gte": "1s",
        "lte": "1s",
        "gt": "1s",
        "lt": "1s"
    },
    "call_sid": {
        "eq": 0,
        "gte": 0,
        "lte": 0,
        "gt": 0,
        "lt": 0,
        "any_of": [
            0
        ]
    },
    "page_size": 0,
    "order_by": "string",
    "page_token": "string",
    "risk_levels": [
        "RISK_LEVEL_NONE"
    ],
    "channel_types": [
        "CHANNEL_TYPE_EMAIL"
    ],
    "agent_user_ids": [
        "string"
    ],
    "scorecard_ids": [
        0
    ],
    "category_ids": [
        0
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

ListAutoEvaluationsResponse returns a list of evaluations.

auto_evaluations

array[object (AutoEvaluation) {17}]

auto_evaluations

optional

List of responses

completed_at

string <date-time>

completed_at

optional

time evaluation was completed

Examples:

1s1.000340012s

deleted_at

string <date-time>

deleted_at

optional

time evaluation was deleted

Examples:

1s1.000340012s

call_type

enum<string>

call_type

deprecated

call type of call being evaluated

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

risk_level

enum<string>

risk_level

optional

The risk level of the evaluation

Allowed values:

RISK_LEVEL_NONERISK_LEVEL_LOWRISK_LEVEL_MEDIUMRISK_LEVEL_HIGHRISK_LEVEL_RISK_FREE

scorecard_info

object (ScorecardInfo)

scorecard_info

optional

read-only info provided from the parent scorecard

category_info

object (CategoryInfo)

category_info

optional

read-only info provided from the parent category

channel_type

enum<string>

channel_type

optional

Channel type of the evaluated transcript.

Allowed values:

CHANNEL_TYPE_EMAILCHANNEL_TYPE_SMSCHANNEL_TYPE_CHATCHANNEL_TYPE_VOICECHANNEL_TYPE_WHATSAPP

call_metadata

object (CallMetadata)

call_metadata

optional

conversation_metadata

object (ConversationMetadata)

conversation_metadata

optional

agent_user_id

string

agent_user_id

optional

user_id of the agent being evaluated

auto_evaluation_sections

array[object (AutoEvaluationSection) {8}]

auto_evaluation_sections

optional

expression_matched

boolean

expression_matched

optional

whether the expression was matched or not

call_length

integer <int32>

call_length

optional

duration of the call audio

auto_evaluation_id

integer <int64> | string

auto_evaluation_id

optional

unique id of the auto evaluation

scorecard_id

integer <int64> | string

scorecard_id

optional

id of evaluated scorecard

call_sid

integer <int64> | string

call_sid

deprecated

sid of the call being evaluated

transcript_sid

integer <int64> | string

transcript_sid

optional

optional - transcript sid associated with evaluation

next_page_token

string

next_page_token

optional

Token to retrieve the next page of auto evaluations, or empty if there are no
more entries in the list.

Example

{
    "auto_evaluations": [
        {
            "completed_at": "1s",
            "deleted_at": "1s",
            "call_type": "INBOUND",
            "risk_level": "RISK_LEVEL_NONE",
            "scorecard_info": {
                "title": "string"
            },
            "category_info": {
                "title": "string"
            },
            "channel_type": "CHANNEL_TYPE_EMAIL",
            "call_metadata": {
                "call_type": "INBOUND",
                "call_sid": 0
            },
            "conversation_metadata": {
                "conversation_sid": 0
            },
            "agent_user_id": "string",
            "auto_evaluation_sections": [
                {
                    "deleted_at": "1s",
                    "created_at": "1s",
                    "risk_level": "RISK_LEVEL_NONE",
                    "sort_order": 0,
                    "auto_evaluation_questions": [
                        {
                            "risk_level": "RISK_LEVEL_NONE",
                            "passed": true,
                            "sort_order": 0,
                            "expression_matched": true,
                            "auto_evaluation_question_id": 0,
                            "auto_evaluation_id": 0,
                            "auto_evaluation_section_id": 0,
                            "auto_question_id": 0,
                            "flagged": [
                                0
                            ]
                        }
                    ],
                    "auto_evaluation_section_id": 0,
                    "auto_evaluation_id": 0,
                    "section_id": 0
                }
            ],
            "expression_matched": true,
            "call_length": 0,
            "auto_evaluation_id": 0,
            "scorecard_id": 0,
            "call_sid": 0,
            "transcript_sid": 0
        }
    ],
    "next_page_token": "string"
}

🔴500Server Error