Evaluations

AI quality assessments of conversations and audio. Retrieve evaluation scores, transcripts, and detailed results for your analyzed interactions.

Endpoints

Method	Endpoint	Description	Scope
GET	/evaluations	List evaluations with filters	evaluations:read
GET	/evaluations/{id}	Get a single evaluation by ID	evaluations:read
GET	/evaluations/{id}/transcript	Get the evaluation transcript	evaluations:read
GET	/evaluations/{id}/results	Get detailed evaluation results	evaluations:read

Query Parameters

Available filters for GET /evaluations

Parameter	Type	Description
engagementId	string	Filter by engagement ID
campaignId	string	Filter by campaign ID
callCenterId	string	Filter by call center ID
dateFrom	ISO 8601	Start date for date range filter
dateTo	ISO 8601	End date for date range filter
state	string	Filter by state: Pending, Processing, Completed, Failed
sentiment	string	Filter by sentiment: Positive, Neutral, Negative
isAICall	boolean	Filter by AI-generated calls
page	integer	Page number (default: 1)
pageSize	integer	Items per page (default: 25, max: 100)

Evaluation Object

Field	Type	Description
id	string	Unique evaluation identifier
engagementId	string	Parent engagement ID
engagementName	string	Name of the parent engagement
audioFileName	string	Original audio file name
audioDate	ISO 8601	Date the audio was recorded
executiveName	string	Name of the executive evaluated
durationInSeconds	number	Duration of the evaluated conversation
state	string	Pending \| Processing \| Completed \| Failed
sentiment	string	Positive \| Neutral \| Negative
averageNote	number	Average score across all evaluation criteria
isAICall	boolean	Whether this was an AI-generated call
campaignId	string	Associated campaign ID
results	object	Detailed evaluation results and scores
createdAt	ISO 8601	Timestamp when the evaluation was created

Example Request

curl https://api.auralytik.com/v1/evaluations?state=Completed&sentiment=Positive&page=1&pageSize=10 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Example Response

{
  "data": [
    {
      "id": "eval_abc123",
      "engagementId": "eng_456",
      "engagementName": "Q1 Quality Review",
      "audioFileName": "call_20240115_143022.wav",
      "audioDate": "2024-01-15T14:30:22Z",
      "executiveName": "Maria Lopez",
      "durationInSeconds": 245,
      "state": "Completed",
      "sentiment": "Positive",
      "averageNote": 8.5,
      "isAICall": false,
      "campaignId": "camp_789",
      "results": {
        "greeting": 9,
        "resolution": 8,
        "compliance": 9,
        "empathy": 8
      },
      "createdAt": "2024-01-15T15:00:00Z"
    }
  ],
  "page": 1,
  "pageSize": 10,
  "totalCount": 142
}

More evaluation endpoints coming soon

Bulk evaluation creation, custom scoring templates, and evaluation export APIs are being developed.

Request API Access