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 from smallestai import SmallestAI
2 
3 client = SmallestAI(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.atoms.agent_versioning_versions.compare_metrics_between_two_versions(
8     id="60d0fe4f5311236168a109ca",
9     version_a="versionA",
10     version_b="versionB",
11 )

1 {
2   "status": true,
3   "data": {
4     "configDiff": {
5       "unchangedSections": [
6         "intents",
7         "entities"
8       ],
9       "diffs": [
10         {
11           "section": "dialogueFlows",
12           "changes": [
13             {
14               "path": "flows[2].steps[4].message",
15               "oldValue": "Welcome to our service. How can I assist you today?",
16               "newValue": "Hello! How may I help you with your inquiry today?"
17             }
18           ]
19         }
20       ]
21     },
22     "metrics": {
23       "versionA": {
24         "orgId": "org_9f8b7c6d5e4a3b2c1d0e",
25         "agentId": "60d0fe4f5311236168a109ca",
26         "versionId": "5f47ac8e9b1d4c3a8f7e2b1c",
27         "totalCalls": 1250,
28         "answeredCalls": 1100,
29         "avgDurationMs": 32000,
30         "completionRate": 0.88,
31         "totalCost": 450.75,
32         "hangupSourceDistribution": {
33           "user": 100,
34           "system": 50,
35           "network": 25
36         },
37         "period": {
38           "dateFrom": "2024-05-01",
39           "dateTo": "2024-05-31"
40         }
41       },
42       "versionB": {
43         "orgId": "org_9f8b7c6d5e4a3b2c1d0e",
44         "agentId": "60d0fe4f5311236168a109ca",
45         "versionId": "6a58bc9f7d2e4f1b9c3d0a2e",
46         "totalCalls": 1400,
47         "answeredCalls": 1250,
48         "avgDurationMs": 29000,
49         "completionRate": 0.89,
50         "totalCost": 480.5,
51         "hangupSourceDistribution": {
52           "user": 120,
53           "system": 70,
54           "network": 30
55         },
56         "period": {
57           "dateFrom": "2024-05-01",
58           "dateTo": "2024-05-31"
59         }
60       },
61       "deltas": {
62         "totalCalls": 150,
63         "answeredCalls": 150,
64         "avgDurationMs": -3000,
65         "completionRate": 0.01,
66         "totalCost": 29.75
67       }
68     }
69   }
70 }

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

dateFromdateOptional

Start date for the comparison range in YYYY-MM-DD format.

dateTodateOptional

End date for the comparison range in YYYY-MM-DD format.

Response

Metrics comparison returned

statusboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error