Compare metrics between two versions

GET

https://api.smallest.ai/atoms/v1/agent/:id/versions/compare-metrics

GET

/atoms/v1/agent/:id/versions/compare-metrics

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/agent/60d0fe4f5311236168a109ca/versions/compare-metrics"
4 
5 querystring = {"versionA":"5f8d0d55b54764421b7156c1","versionB":"5f8d0d55b54764421b7156c2","dateFrom":"2024-05-01T00:00:00Z","dateTo":"2024-05-15T23:59:59Z"}
6 
7 payload = { "id": "60d0fe4f5311236168a109ca" }
8 headers = {
9     "Authorization": "Bearer <token>",
10     "Content-Type": "application/json"
11 }
12 
13 response = requests.get(url, json=payload, headers=headers, params=querystring)
14 
15 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "5f8d0d55b54764421b7156c1": {
5       "totalCalls": 1200,
6       "averageCallDurationSeconds": 320,
7       "successfulCalls": 1150,
8       "failedCalls": 50,
9       "averageSentimentScore": 0.85,
10       "uniqueCallers": 980
11     },
12     "5f8d0d55b54764421b7156c2": {
13       "totalCalls": 1350,
14       "averageCallDurationSeconds": 300,
15       "successfulCalls": 1300,
16       "failedCalls": 50,
17       "averageSentimentScore": 0.88,
18       "uniqueCallers": 1100
19     }
20   }
21 }

Compare analytics/call metrics between two published versions over an optional date range.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequired

The agent ID

Query parameters

versionAstringRequiredformat: "^[a-f\d]{24}$"

ID of the first version

versionBstringRequiredformat: "^[a-f\d]{24}$"

ID of the second version

dateFromdatetimeOptional

Start date for the comparison range (ISO 8601)

dateTodatetimeOptional

End date for the comparison range (ISO 8601)

Response

Metrics comparison returned

statusboolean

dataobject

Aggregated metrics for each version

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error