SampleAgentConversations

POST

https://api.cbf.tcn.com/api/v1alpha1/scorecards/scorecards/sampleagentconversations

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

SampleAgentConversationsRequest is a request to sample conversations for evaluating.

start_time

string <date-time>

start_time

optional

Required - oldest samples applicable.

Examples:

1s1.000340012s

end_time

string <date-time>

end_time

optional

Optional - defaults to now.

Examples:

1s1.000340012s

max_agent_evaluations

integer <int32>

max_agent_evaluations

optional

Required - maximum evaluations allowed per agent.

sample_percentage

integer <int32>

sample_percentage

optional

Optional - defaults to 100.

scorecard_id

integer <int64> | string

scorecard_id

optional

Required - determines applicable conversations.

agent_user_ids

array[string]

agent_user_ids

optional

Optional - filter by agents.

filter_sid

integer <int64> | string

filter_sid

optional

Optional - filter by saved transcript filter.

Example

{
    "start_time": "1s",
    "end_time": "1s",
    "max_agent_evaluations": 0,
    "sample_percentage": 0,
    "scorecard_id": 0,
    "agent_user_ids": [
        "string"
    ],
    "filter_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/scorecards/scorecards/sampleagentconversations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_time": "1s",
    "end_time": "1s",
    "max_agent_evaluations": 0,
    "sample_percentage": 0,
    "scorecard_id": 0,
    "agent_user_ids": [
        "string"
    ],
    "filter_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

SampleAgentConversationsResponse returns the sampled conversations.

agent_conversations

array[null (AgentConversation) {3}]

agent_conversations

optional

object

call_metadata

optional

object

chat_metadata

optional

object

sms_metadata

optional

Example

{
    "agent_conversations": [
        {
            "call_metadata": {
                "call_type": "INBOUND",
                "call_duration": "string",
                "speech_duration": "string",
                "silence_duration": "string",
                "call_sid": 0
            }
        }
    ]
}

🔴500Server Error

Modified at 2025-07-10 17:42:28

SampleCallsByCategory

CreateAutoQuestion