Home//
REST API Reference
/- Conversation Scorecard
Add tag to a conversation
Remove tag from a conversation
List all conversations
Creates a conversation
Retrieve a conversation
Update a conversation
Delete a conversation
Search conversations
Reply to a conversation
Manage a conversation
Attach a contact to a conversation
Detach a contact from a group conversation
List handling events
List side conversations
Rate a conversation
Redact a conversation part
Merge a conversation
Convert a conversation to a ticket
List all deleted conversation IDs
Create a conversation stream token
Revoke conversation stream tokens
Conversation
Conversation List Item
Conversation Monitor Evaluation
Conversation Scorecard Evaluator
Conversation Scorecard Evaluator Result
Reviewed Teammate
Conversation stream token
Merge Conversations Request
Rated conversation
Conversation Scorecard
A QA scorecard result for this conversation. Returned in the scorecards array on conversation responses when include_scorecards=true is passed.
The unique identifier of the specific scorecard version that produced this result.
Example:"67891"
Whether the conversation passed the scorecard. Null when the scorecard has not been scored.
Example:true
The numeric score for the scorecard. Null when the scorecard has not been scored.
Example:0.85
The numeric score produced by AI evaluation, if applicable. Null when not AI-scored.
Example:0.9
The time the scorecard was last evaluated. Null in the rare case the underlying record's timestamp is not yet set.
Example:1719493065
reviewed_teammateobject(Reviewed Teammate)
The teammate (or AI agent) whose handling of the conversation was reviewed by this scorecard.
evaluatorsArray of objects(Conversation Scorecard Evaluator)
Per-evaluator results within this scorecard.
{ "scorecard_id": "67890", "scorecard_version_id": "67891", "name": "Standard QA Review", "scorecard_type": "human", "passed": true, "score": 0.85, "ai_score": 0.9, "evaluated_at": 1719493065, "reviewed_teammate": { "type": "admin", "admin_id": "991267715" }, "evaluators": [ { … } ] }