@breign/client 1.0.112 → 1.0.114
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apis/AgentApi.d.ts +60 -10
- package/dist/apis/AgentApi.js +99 -7
- package/dist/apis/MetricsApi.d.ts +131 -7
- package/dist/apis/MetricsApi.js +269 -5
- package/dist/models/AgentFeedbackMetricsUio.d.ts +50 -0
- package/dist/models/AgentFeedbackMetricsUio.js +60 -0
- package/dist/models/AgentMetricsByAppUio.d.ts +56 -0
- package/dist/models/AgentMetricsByAppUio.js +64 -0
- package/dist/models/AgentMetricsOverviewUio.d.ts +79 -0
- package/dist/models/AgentMetricsOverviewUio.js +31 -0
- package/dist/models/AgentMetricsPeriodComparisonUio.d.ts +41 -0
- package/dist/models/AgentMetricsPeriodComparisonUio.js +55 -0
- package/dist/models/AgentMetricsPeriodSnapshotUio.d.ts +68 -0
- package/dist/models/AgentMetricsPeriodSnapshotUio.js +74 -0
- package/dist/models/AgentMetricsUnitsTypeUio.d.ts +1 -0
- package/dist/models/AgentMetricsUnitsTypeUio.js +2 -1
- package/dist/models/AgentTokenBreakdownUio.d.ts +44 -0
- package/dist/models/AgentTokenBreakdownUio.js +58 -0
- package/dist/models/AgentTokenUsageByTaskUio.d.ts +38 -0
- package/dist/models/AgentTokenUsageByTaskUio.js +54 -0
- package/dist/models/AgentTokenUsageMetricUio.d.ts +56 -0
- package/dist/models/AgentTokenUsageMetricUio.js +66 -0
- package/dist/models/AgentToolUsageMetricUio.d.ts +38 -0
- package/dist/models/AgentToolUsageMetricUio.js +54 -0
- package/dist/models/AppCreateRequestEphemeralInstancesUio.d.ts +2 -2
- package/dist/models/AppCreateRequestEphemeralInstancesUio.js +6 -2
- package/dist/models/EphemeralInstancesMetricsResponseUio.d.ts +39 -0
- package/dist/models/EphemeralInstancesMetricsResponseUio.js +55 -0
- package/dist/models/EphemeralInstancesTimeSeriesPointUio.d.ts +44 -0
- package/dist/models/EphemeralInstancesTimeSeriesPointUio.js +58 -0
- package/dist/models/KnowledgeBaseConfigurationUio.d.ts +12 -0
- package/dist/models/KnowledgeBaseConfigurationUio.js +4 -0
- package/dist/models/MetricForDayInnerIdUio.d.ts +56 -0
- package/dist/models/MetricForDayInnerIdUio.js +56 -0
- package/dist/models/MetricForDayInnerUio.d.ts +51 -0
- package/dist/models/MetricForDayInnerUio.js +57 -0
- package/dist/models/MetricForVisitorByMonthInnerUio.d.ts +44 -0
- package/dist/models/MetricForVisitorByMonthInnerUio.js +58 -0
- package/dist/models/MetricUio.d.ts +6 -0
- package/dist/models/MetricUio.js +2 -0
- package/dist/models/MetricsBrainsAgentResponseUio.d.ts +51 -0
- package/dist/models/MetricsBrainsAgentResponseUio.js +63 -0
- package/dist/models/MetricsTopAgentsResponseInnerUio.d.ts +50 -0
- package/dist/models/MetricsTopAgentsResponseInnerUio.js +54 -0
- package/dist/models/MetricsTopAgentsUsageResponseInnerUio.d.ts +44 -0
- package/dist/models/MetricsTopAgentsUsageResponseInnerUio.js +58 -0
- package/dist/models/MetricsUsersResponseUio.d.ts +39 -0
- package/dist/models/MetricsUsersResponseUio.js +55 -0
- package/dist/models/OrgUsageMetricsResponseTotalUio.d.ts +38 -0
- package/dist/models/OrgUsageMetricsResponseTotalUio.js +54 -0
- package/dist/models/OrgUsageMetricsResponseUio.d.ts +40 -0
- package/dist/models/OrgUsageMetricsResponseUio.js +56 -0
- package/dist/models/OrgUsageTimeSeriesPointUio.d.ts +50 -0
- package/dist/models/OrgUsageTimeSeriesPointUio.js +62 -0
- package/dist/models/SearchKnowledgeBase200ResponseInnerUio.d.ts +6 -0
- package/dist/models/SearchKnowledgeBase200ResponseInnerUio.js +2 -0
- package/dist/models/SubscriptionAdditionalMetricUio.d.ts +44 -0
- package/dist/models/SubscriptionAdditionalMetricUio.js +58 -0
- package/dist/models/SubscriptionInteractionsMetricUio.d.ts +39 -0
- package/dist/models/SubscriptionInteractionsMetricUio.js +55 -0
- package/dist/models/SubscriptionMetricUio.d.ts +6 -5
- package/dist/models/SubscriptionMetricUio.js +12 -5
- package/dist/models/TotalTokensUsedByAgentUio.d.ts +38 -0
- package/dist/models/TotalTokensUsedByAgentUio.js +50 -0
- package/dist/models/index.d.ts +23 -0
- package/dist/models/index.js +23 -0
- package/dist/openapi.json +1069 -61
- package/package.json +1 -1
package/dist/openapi.json
CHANGED
|
@@ -509,7 +509,6 @@
|
|
|
509
509
|
"in" : "query",
|
|
510
510
|
"name" : "startDate",
|
|
511
511
|
"schema" : {
|
|
512
|
-
"format" : "date-time",
|
|
513
512
|
"type" : "string"
|
|
514
513
|
}
|
|
515
514
|
}, {
|
|
@@ -517,7 +516,6 @@
|
|
|
517
516
|
"in" : "query",
|
|
518
517
|
"name" : "endDate",
|
|
519
518
|
"schema" : {
|
|
520
|
-
"format" : "date-time",
|
|
521
519
|
"type" : "string"
|
|
522
520
|
}
|
|
523
521
|
} ],
|
|
@@ -552,6 +550,136 @@
|
|
|
552
550
|
"tags" : [ "agent" ]
|
|
553
551
|
}
|
|
554
552
|
},
|
|
553
|
+
"/agents/{agentId}/metrics/ephemeral-instances" : {
|
|
554
|
+
"get" : {
|
|
555
|
+
"description" : "Returns ephemeral instance creation counts over time for an agent",
|
|
556
|
+
"operationId" : "getAgentMetricsEphemeralInstances",
|
|
557
|
+
"parameters" : [ {
|
|
558
|
+
"description" : "ID of the agent",
|
|
559
|
+
"in" : "path",
|
|
560
|
+
"name" : "agentId",
|
|
561
|
+
"required" : true,
|
|
562
|
+
"schema" : {
|
|
563
|
+
"format" : "uuid",
|
|
564
|
+
"type" : "string"
|
|
565
|
+
}
|
|
566
|
+
}, {
|
|
567
|
+
"description" : "Start date for metrics (ISO format)",
|
|
568
|
+
"in" : "query",
|
|
569
|
+
"name" : "startDate",
|
|
570
|
+
"schema" : {
|
|
571
|
+
"type" : "string"
|
|
572
|
+
}
|
|
573
|
+
}, {
|
|
574
|
+
"description" : "End date for metrics (ISO format)",
|
|
575
|
+
"in" : "query",
|
|
576
|
+
"name" : "endDate",
|
|
577
|
+
"schema" : {
|
|
578
|
+
"type" : "string"
|
|
579
|
+
}
|
|
580
|
+
}, {
|
|
581
|
+
"in" : "query",
|
|
582
|
+
"name" : "granularity",
|
|
583
|
+
"required" : false,
|
|
584
|
+
"schema" : {
|
|
585
|
+
"default" : "day",
|
|
586
|
+
"enum" : [ "hour", "day", "week" ],
|
|
587
|
+
"type" : "string"
|
|
588
|
+
}
|
|
589
|
+
} ],
|
|
590
|
+
"responses" : {
|
|
591
|
+
"200" : {
|
|
592
|
+
"content" : {
|
|
593
|
+
"application/json" : {
|
|
594
|
+
"schema" : {
|
|
595
|
+
"$ref" : "#/components/schemas/EphemeralInstancesMetricsResponse"
|
|
596
|
+
}
|
|
597
|
+
}
|
|
598
|
+
},
|
|
599
|
+
"description" : "Ephemeral instances metrics retrieved successfully"
|
|
600
|
+
},
|
|
601
|
+
"401" : {
|
|
602
|
+
"description" : "Unauthorized"
|
|
603
|
+
},
|
|
604
|
+
"403" : {
|
|
605
|
+
"description" : "Forbidden"
|
|
606
|
+
},
|
|
607
|
+
"404" : {
|
|
608
|
+
"description" : "Agent not found"
|
|
609
|
+
},
|
|
610
|
+
"500" : {
|
|
611
|
+
"description" : "Server error"
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
"summary" : "Get ephemeral instances metrics for an agent",
|
|
615
|
+
"tags" : [ "agent" ]
|
|
616
|
+
}
|
|
617
|
+
},
|
|
618
|
+
"/agents/{agentId}/metrics/usage" : {
|
|
619
|
+
"get" : {
|
|
620
|
+
"description" : "Returns LLM requests and token usage over time for a specific agent",
|
|
621
|
+
"operationId" : "getAgentMetricsUsage",
|
|
622
|
+
"parameters" : [ {
|
|
623
|
+
"description" : "ID of the agent",
|
|
624
|
+
"in" : "path",
|
|
625
|
+
"name" : "agentId",
|
|
626
|
+
"required" : true,
|
|
627
|
+
"schema" : {
|
|
628
|
+
"format" : "uuid",
|
|
629
|
+
"type" : "string"
|
|
630
|
+
}
|
|
631
|
+
}, {
|
|
632
|
+
"description" : "Start date for metrics (ISO format)",
|
|
633
|
+
"in" : "query",
|
|
634
|
+
"name" : "startDate",
|
|
635
|
+
"schema" : {
|
|
636
|
+
"type" : "string"
|
|
637
|
+
}
|
|
638
|
+
}, {
|
|
639
|
+
"description" : "End date for metrics (ISO format)",
|
|
640
|
+
"in" : "query",
|
|
641
|
+
"name" : "endDate",
|
|
642
|
+
"schema" : {
|
|
643
|
+
"type" : "string"
|
|
644
|
+
}
|
|
645
|
+
}, {
|
|
646
|
+
"in" : "query",
|
|
647
|
+
"name" : "granularity",
|
|
648
|
+
"required" : false,
|
|
649
|
+
"schema" : {
|
|
650
|
+
"default" : "day",
|
|
651
|
+
"enum" : [ "hour", "day", "week" ],
|
|
652
|
+
"type" : "string"
|
|
653
|
+
}
|
|
654
|
+
} ],
|
|
655
|
+
"responses" : {
|
|
656
|
+
"200" : {
|
|
657
|
+
"content" : {
|
|
658
|
+
"application/json" : {
|
|
659
|
+
"schema" : {
|
|
660
|
+
"$ref" : "#/components/schemas/OrgUsageMetricsResponse"
|
|
661
|
+
}
|
|
662
|
+
}
|
|
663
|
+
},
|
|
664
|
+
"description" : "Usage metrics retrieved successfully"
|
|
665
|
+
},
|
|
666
|
+
"401" : {
|
|
667
|
+
"description" : "Unauthorized"
|
|
668
|
+
},
|
|
669
|
+
"403" : {
|
|
670
|
+
"description" : "Forbidden"
|
|
671
|
+
},
|
|
672
|
+
"404" : {
|
|
673
|
+
"description" : "Agent not found"
|
|
674
|
+
},
|
|
675
|
+
"500" : {
|
|
676
|
+
"description" : "Server error"
|
|
677
|
+
}
|
|
678
|
+
},
|
|
679
|
+
"summary" : "Get usage metrics for an agent",
|
|
680
|
+
"tags" : [ "agent" ]
|
|
681
|
+
}
|
|
682
|
+
},
|
|
555
683
|
"/agents/{agentId}/metrics" : {
|
|
556
684
|
"get" : {
|
|
557
685
|
"description" : "Retrieves detailed usage metrics for a specific agent (admin only)",
|
|
@@ -570,7 +698,6 @@
|
|
|
570
698
|
"in" : "query",
|
|
571
699
|
"name" : "startDate",
|
|
572
700
|
"schema" : {
|
|
573
|
-
"format" : "date-time",
|
|
574
701
|
"type" : "string"
|
|
575
702
|
}
|
|
576
703
|
}, {
|
|
@@ -578,7 +705,6 @@
|
|
|
578
705
|
"in" : "query",
|
|
579
706
|
"name" : "endDate",
|
|
580
707
|
"schema" : {
|
|
581
|
-
"format" : "date-time",
|
|
582
708
|
"type" : "string"
|
|
583
709
|
}
|
|
584
710
|
} ],
|
|
@@ -639,7 +765,6 @@
|
|
|
639
765
|
"in" : "query",
|
|
640
766
|
"name" : "startDate",
|
|
641
767
|
"schema" : {
|
|
642
|
-
"format" : "date-time",
|
|
643
768
|
"type" : "string"
|
|
644
769
|
}
|
|
645
770
|
}, {
|
|
@@ -647,7 +772,6 @@
|
|
|
647
772
|
"in" : "query",
|
|
648
773
|
"name" : "endDate",
|
|
649
774
|
"schema" : {
|
|
650
|
-
"format" : "date-time",
|
|
651
775
|
"type" : "string"
|
|
652
776
|
}
|
|
653
777
|
} ],
|
|
@@ -5240,7 +5364,335 @@
|
|
|
5240
5364
|
"name" : "fileId",
|
|
5241
5365
|
"required" : true,
|
|
5242
5366
|
"schema" : {
|
|
5243
|
-
"type" : "string"
|
|
5367
|
+
"type" : "string"
|
|
5368
|
+
}
|
|
5369
|
+
} ],
|
|
5370
|
+
"responses" : {
|
|
5371
|
+
"200" : {
|
|
5372
|
+
"content" : {
|
|
5373
|
+
"application/json" : {
|
|
5374
|
+
"schema" : {
|
|
5375
|
+
"$ref" : "#/components/schemas/FileWithDownloadUrl"
|
|
5376
|
+
}
|
|
5377
|
+
}
|
|
5378
|
+
},
|
|
5379
|
+
"description" : "File retrieved successfully"
|
|
5380
|
+
},
|
|
5381
|
+
"401" : {
|
|
5382
|
+
"description" : "Unauthorized"
|
|
5383
|
+
},
|
|
5384
|
+
"403" : {
|
|
5385
|
+
"description" : "Forbidden - User is not an admin"
|
|
5386
|
+
},
|
|
5387
|
+
"404" : {
|
|
5388
|
+
"description" : "File not found"
|
|
5389
|
+
}
|
|
5390
|
+
},
|
|
5391
|
+
"summary" : "Get a file by ID",
|
|
5392
|
+
"tags" : [ "files" ]
|
|
5393
|
+
}
|
|
5394
|
+
},
|
|
5395
|
+
"/metrics" : {
|
|
5396
|
+
"get" : {
|
|
5397
|
+
"description" : "Retrieves usage metrics for all agents within a date range (admin only)",
|
|
5398
|
+
"operationId" : "getMetrics",
|
|
5399
|
+
"parameters" : [ {
|
|
5400
|
+
"description" : "Start date for metrics (ISO format)",
|
|
5401
|
+
"in" : "query",
|
|
5402
|
+
"name" : "startDate",
|
|
5403
|
+
"schema" : {
|
|
5404
|
+
"type" : "string"
|
|
5405
|
+
}
|
|
5406
|
+
}, {
|
|
5407
|
+
"description" : "End date for metrics (ISO format)",
|
|
5408
|
+
"in" : "query",
|
|
5409
|
+
"name" : "endDate",
|
|
5410
|
+
"schema" : {
|
|
5411
|
+
"type" : "string"
|
|
5412
|
+
}
|
|
5413
|
+
} ],
|
|
5414
|
+
"responses" : {
|
|
5415
|
+
"200" : {
|
|
5416
|
+
"content" : {
|
|
5417
|
+
"application/json" : {
|
|
5418
|
+
"schema" : {
|
|
5419
|
+
"items" : {
|
|
5420
|
+
"$ref" : "#/components/schemas/Metric"
|
|
5421
|
+
},
|
|
5422
|
+
"type" : "array"
|
|
5423
|
+
}
|
|
5424
|
+
}
|
|
5425
|
+
},
|
|
5426
|
+
"description" : "Metrics retrieved successfully"
|
|
5427
|
+
},
|
|
5428
|
+
"400" : {
|
|
5429
|
+
"description" : "Invalid date format"
|
|
5430
|
+
},
|
|
5431
|
+
"401" : {
|
|
5432
|
+
"description" : "Unauthorized"
|
|
5433
|
+
},
|
|
5434
|
+
"403" : {
|
|
5435
|
+
"description" : "Forbidden - User is not an admin"
|
|
5436
|
+
},
|
|
5437
|
+
"500" : {
|
|
5438
|
+
"description" : "Server error"
|
|
5439
|
+
}
|
|
5440
|
+
},
|
|
5441
|
+
"summary" : "Get usage metrics",
|
|
5442
|
+
"tags" : [ "metrics" ]
|
|
5443
|
+
}
|
|
5444
|
+
},
|
|
5445
|
+
"/metrics/agents" : {
|
|
5446
|
+
"get" : {
|
|
5447
|
+
"description" : "Retrieves usage metrics broken down by agent within a date range (admin only)",
|
|
5448
|
+
"operationId" : "getMetricsAgents",
|
|
5449
|
+
"parameters" : [ {
|
|
5450
|
+
"description" : "Start date for metrics (ISO format)",
|
|
5451
|
+
"in" : "query",
|
|
5452
|
+
"name" : "startDate",
|
|
5453
|
+
"schema" : {
|
|
5454
|
+
"type" : "string"
|
|
5455
|
+
}
|
|
5456
|
+
}, {
|
|
5457
|
+
"description" : "End date for metrics (ISO format)",
|
|
5458
|
+
"in" : "query",
|
|
5459
|
+
"name" : "endDate",
|
|
5460
|
+
"schema" : {
|
|
5461
|
+
"type" : "string"
|
|
5462
|
+
}
|
|
5463
|
+
} ],
|
|
5464
|
+
"responses" : {
|
|
5465
|
+
"200" : {
|
|
5466
|
+
"content" : {
|
|
5467
|
+
"application/json" : {
|
|
5468
|
+
"schema" : {
|
|
5469
|
+
"items" : {
|
|
5470
|
+
"$ref" : "#/components/schemas/MetricForAgent"
|
|
5471
|
+
},
|
|
5472
|
+
"type" : "array"
|
|
5473
|
+
}
|
|
5474
|
+
}
|
|
5475
|
+
},
|
|
5476
|
+
"description" : "Agent metrics retrieved successfully"
|
|
5477
|
+
},
|
|
5478
|
+
"400" : {
|
|
5479
|
+
"description" : "Invalid date format"
|
|
5480
|
+
},
|
|
5481
|
+
"401" : {
|
|
5482
|
+
"description" : "Unauthorized"
|
|
5483
|
+
},
|
|
5484
|
+
"403" : {
|
|
5485
|
+
"description" : "Forbidden - User is not an admin"
|
|
5486
|
+
},
|
|
5487
|
+
"500" : {
|
|
5488
|
+
"description" : "Server error"
|
|
5489
|
+
}
|
|
5490
|
+
},
|
|
5491
|
+
"summary" : "Get agent-specific metrics",
|
|
5492
|
+
"tags" : [ "metrics" ]
|
|
5493
|
+
}
|
|
5494
|
+
},
|
|
5495
|
+
"/metrics/organizations/{organizationId}/day-metrics" : {
|
|
5496
|
+
"get" : {
|
|
5497
|
+
"description" : "Retrieves usage metrics broken down by day within a date range (admin only)",
|
|
5498
|
+
"operationId" : "getMetricsDayMetrics",
|
|
5499
|
+
"parameters" : [ {
|
|
5500
|
+
"description" : "ID of the organization",
|
|
5501
|
+
"in" : "path",
|
|
5502
|
+
"name" : "organizationId",
|
|
5503
|
+
"required" : true,
|
|
5504
|
+
"schema" : {
|
|
5505
|
+
"type" : "string"
|
|
5506
|
+
}
|
|
5507
|
+
} ],
|
|
5508
|
+
"responses" : {
|
|
5509
|
+
"200" : {
|
|
5510
|
+
"content" : {
|
|
5511
|
+
"application/json" : {
|
|
5512
|
+
"schema" : {
|
|
5513
|
+
"items" : {
|
|
5514
|
+
"$ref" : "#/components/schemas/MetricForDay"
|
|
5515
|
+
},
|
|
5516
|
+
"type" : "array"
|
|
5517
|
+
}
|
|
5518
|
+
}
|
|
5519
|
+
},
|
|
5520
|
+
"description" : "Day metrics retrieved successfully"
|
|
5521
|
+
},
|
|
5522
|
+
"400" : {
|
|
5523
|
+
"description" : "Invalid date format"
|
|
5524
|
+
},
|
|
5525
|
+
"401" : {
|
|
5526
|
+
"description" : "Unauthorized"
|
|
5527
|
+
},
|
|
5528
|
+
"403" : {
|
|
5529
|
+
"description" : "Forbidden - User is not an admin"
|
|
5530
|
+
},
|
|
5531
|
+
"500" : {
|
|
5532
|
+
"description" : "Server error"
|
|
5533
|
+
}
|
|
5534
|
+
},
|
|
5535
|
+
"summary" : "Get day-specific metrics",
|
|
5536
|
+
"tags" : [ "metrics" ]
|
|
5537
|
+
}
|
|
5538
|
+
},
|
|
5539
|
+
"/metrics/organizations/{organizationId}/users" : {
|
|
5540
|
+
"get" : {
|
|
5541
|
+
"description" : "Retrieves usage metrics broken down by users within a date range (admin only)",
|
|
5542
|
+
"operationId" : "getMetricsUsersVisitors",
|
|
5543
|
+
"parameters" : [ {
|
|
5544
|
+
"description" : "Start date for metrics (ISO format)",
|
|
5545
|
+
"in" : "query",
|
|
5546
|
+
"name" : "startDate",
|
|
5547
|
+
"schema" : {
|
|
5548
|
+
"type" : "string"
|
|
5549
|
+
}
|
|
5550
|
+
}, {
|
|
5551
|
+
"description" : "End date for metrics (ISO format)",
|
|
5552
|
+
"in" : "query",
|
|
5553
|
+
"name" : "endDate",
|
|
5554
|
+
"schema" : {
|
|
5555
|
+
"type" : "string"
|
|
5556
|
+
}
|
|
5557
|
+
}, {
|
|
5558
|
+
"description" : "ID of the organization",
|
|
5559
|
+
"in" : "path",
|
|
5560
|
+
"name" : "organizationId",
|
|
5561
|
+
"required" : true,
|
|
5562
|
+
"schema" : {
|
|
5563
|
+
"type" : "string"
|
|
5564
|
+
}
|
|
5565
|
+
} ],
|
|
5566
|
+
"responses" : {
|
|
5567
|
+
"200" : {
|
|
5568
|
+
"content" : {
|
|
5569
|
+
"application/json" : {
|
|
5570
|
+
"schema" : {
|
|
5571
|
+
"$ref" : "#/components/schemas/MetricsUsersResponse"
|
|
5572
|
+
}
|
|
5573
|
+
}
|
|
5574
|
+
},
|
|
5575
|
+
"description" : "Users metrics retrieved successfully"
|
|
5576
|
+
},
|
|
5577
|
+
"400" : {
|
|
5578
|
+
"description" : "Invalid date format"
|
|
5579
|
+
},
|
|
5580
|
+
"401" : {
|
|
5581
|
+
"description" : "Unauthorized"
|
|
5582
|
+
},
|
|
5583
|
+
"403" : {
|
|
5584
|
+
"description" : "Forbidden - User is not an admin"
|
|
5585
|
+
},
|
|
5586
|
+
"500" : {
|
|
5587
|
+
"description" : "Server error"
|
|
5588
|
+
}
|
|
5589
|
+
},
|
|
5590
|
+
"summary" : "Get users metrics",
|
|
5591
|
+
"tags" : [ "metrics" ]
|
|
5592
|
+
}
|
|
5593
|
+
},
|
|
5594
|
+
"/metrics/organizations/{organizationId}/top-agents/conversations" : {
|
|
5595
|
+
"get" : {
|
|
5596
|
+
"description" : "Retrieves usage metrics broken down by top agents within a date range (admin only)",
|
|
5597
|
+
"operationId" : "getMetricsTopAgents",
|
|
5598
|
+
"parameters" : [ {
|
|
5599
|
+
"description" : "Start date for metrics (ISO format)",
|
|
5600
|
+
"in" : "query",
|
|
5601
|
+
"name" : "startDate",
|
|
5602
|
+
"schema" : {
|
|
5603
|
+
"type" : "string"
|
|
5604
|
+
}
|
|
5605
|
+
}, {
|
|
5606
|
+
"description" : "End date for metrics (ISO format)",
|
|
5607
|
+
"in" : "query",
|
|
5608
|
+
"name" : "endDate",
|
|
5609
|
+
"schema" : {
|
|
5610
|
+
"type" : "string"
|
|
5611
|
+
}
|
|
5612
|
+
}, {
|
|
5613
|
+
"description" : "Agents IDs to filter metrics",
|
|
5614
|
+
"in" : "query",
|
|
5615
|
+
"name" : "agentsIds",
|
|
5616
|
+
"schema" : {
|
|
5617
|
+
"items" : {
|
|
5618
|
+
"format" : "uuid",
|
|
5619
|
+
"type" : "string"
|
|
5620
|
+
},
|
|
5621
|
+
"type" : "array"
|
|
5622
|
+
}
|
|
5623
|
+
}, {
|
|
5624
|
+
"description" : "ID of the organization",
|
|
5625
|
+
"in" : "path",
|
|
5626
|
+
"name" : "organizationId",
|
|
5627
|
+
"required" : true,
|
|
5628
|
+
"schema" : {
|
|
5629
|
+
"type" : "string"
|
|
5630
|
+
}
|
|
5631
|
+
} ],
|
|
5632
|
+
"responses" : {
|
|
5633
|
+
"200" : {
|
|
5634
|
+
"content" : {
|
|
5635
|
+
"application/json" : {
|
|
5636
|
+
"schema" : {
|
|
5637
|
+
"$ref" : "#/components/schemas/MetricsTopAgentsResponse"
|
|
5638
|
+
}
|
|
5639
|
+
}
|
|
5640
|
+
},
|
|
5641
|
+
"description" : "Top agents metrics retrieved successfully"
|
|
5642
|
+
},
|
|
5643
|
+
"400" : {
|
|
5644
|
+
"description" : "Invalid date format"
|
|
5645
|
+
},
|
|
5646
|
+
"401" : {
|
|
5647
|
+
"description" : "Unauthorized"
|
|
5648
|
+
},
|
|
5649
|
+
"403" : {
|
|
5650
|
+
"description" : "Forbidden - User is not an admin"
|
|
5651
|
+
},
|
|
5652
|
+
"500" : {
|
|
5653
|
+
"description" : "Server error"
|
|
5654
|
+
}
|
|
5655
|
+
},
|
|
5656
|
+
"summary" : "Get top agents metrics",
|
|
5657
|
+
"tags" : [ "metrics" ]
|
|
5658
|
+
}
|
|
5659
|
+
},
|
|
5660
|
+
"/metrics/organizations/{organizationId}/top-agents/usage" : {
|
|
5661
|
+
"get" : {
|
|
5662
|
+
"description" : "Retrieves usage metrics broken down by top agents within a date range (admin only)",
|
|
5663
|
+
"operationId" : "getMetricsTopAgentsUsage",
|
|
5664
|
+
"parameters" : [ {
|
|
5665
|
+
"description" : "Start date for metrics (ISO format)",
|
|
5666
|
+
"in" : "query",
|
|
5667
|
+
"name" : "startDate",
|
|
5668
|
+
"schema" : {
|
|
5669
|
+
"type" : "string"
|
|
5670
|
+
}
|
|
5671
|
+
}, {
|
|
5672
|
+
"description" : "End date for metrics (ISO format)",
|
|
5673
|
+
"in" : "query",
|
|
5674
|
+
"name" : "endDate",
|
|
5675
|
+
"schema" : {
|
|
5676
|
+
"type" : "string"
|
|
5677
|
+
}
|
|
5678
|
+
}, {
|
|
5679
|
+
"description" : "ID of the organization",
|
|
5680
|
+
"in" : "path",
|
|
5681
|
+
"name" : "organizationId",
|
|
5682
|
+
"required" : true,
|
|
5683
|
+
"schema" : {
|
|
5684
|
+
"type" : "string"
|
|
5685
|
+
}
|
|
5686
|
+
}, {
|
|
5687
|
+
"description" : "Agents IDs to filter metrics",
|
|
5688
|
+
"in" : "query",
|
|
5689
|
+
"name" : "agentsIds",
|
|
5690
|
+
"schema" : {
|
|
5691
|
+
"items" : {
|
|
5692
|
+
"format" : "uuid",
|
|
5693
|
+
"type" : "string"
|
|
5694
|
+
},
|
|
5695
|
+
"type" : "array"
|
|
5244
5696
|
}
|
|
5245
5697
|
} ],
|
|
5246
5698
|
"responses" : {
|
|
@@ -5248,11 +5700,14 @@
|
|
|
5248
5700
|
"content" : {
|
|
5249
5701
|
"application/json" : {
|
|
5250
5702
|
"schema" : {
|
|
5251
|
-
"$ref" : "#/components/schemas/
|
|
5703
|
+
"$ref" : "#/components/schemas/MetricsTopAgentsUsageResponse"
|
|
5252
5704
|
}
|
|
5253
5705
|
}
|
|
5254
5706
|
},
|
|
5255
|
-
"description" : "
|
|
5707
|
+
"description" : "Top agents usage metrics retrieved successfully"
|
|
5708
|
+
},
|
|
5709
|
+
"400" : {
|
|
5710
|
+
"description" : "Invalid date format"
|
|
5256
5711
|
},
|
|
5257
5712
|
"401" : {
|
|
5258
5713
|
"description" : "Unauthorized"
|
|
@@ -5260,24 +5715,31 @@
|
|
|
5260
5715
|
"403" : {
|
|
5261
5716
|
"description" : "Forbidden - User is not an admin"
|
|
5262
5717
|
},
|
|
5263
|
-
"
|
|
5264
|
-
"description" : "
|
|
5718
|
+
"500" : {
|
|
5719
|
+
"description" : "Server error"
|
|
5265
5720
|
}
|
|
5266
5721
|
},
|
|
5267
|
-
"summary" : "Get
|
|
5268
|
-
"tags" : [ "
|
|
5722
|
+
"summary" : "Get top agents usage metrics",
|
|
5723
|
+
"tags" : [ "metrics" ]
|
|
5269
5724
|
}
|
|
5270
5725
|
},
|
|
5271
|
-
"/metrics" : {
|
|
5726
|
+
"/metrics/organizations/{organizationId}/ephemeral-instances" : {
|
|
5272
5727
|
"get" : {
|
|
5273
|
-
"description" : "
|
|
5274
|
-
"operationId" : "
|
|
5728
|
+
"description" : "Returns ephemeral instance creation counts over time for all agents in the organization",
|
|
5729
|
+
"operationId" : "getMetricsOrganizationEphemeralInstances",
|
|
5275
5730
|
"parameters" : [ {
|
|
5731
|
+
"description" : "ID of the organization",
|
|
5732
|
+
"in" : "path",
|
|
5733
|
+
"name" : "organizationId",
|
|
5734
|
+
"required" : true,
|
|
5735
|
+
"schema" : {
|
|
5736
|
+
"type" : "string"
|
|
5737
|
+
}
|
|
5738
|
+
}, {
|
|
5276
5739
|
"description" : "Start date for metrics (ISO format)",
|
|
5277
5740
|
"in" : "query",
|
|
5278
5741
|
"name" : "startDate",
|
|
5279
5742
|
"schema" : {
|
|
5280
|
-
"format" : "date-time",
|
|
5281
5743
|
"type" : "string"
|
|
5282
5744
|
}
|
|
5283
5745
|
}, {
|
|
@@ -5285,7 +5747,15 @@
|
|
|
5285
5747
|
"in" : "query",
|
|
5286
5748
|
"name" : "endDate",
|
|
5287
5749
|
"schema" : {
|
|
5288
|
-
"
|
|
5750
|
+
"type" : "string"
|
|
5751
|
+
}
|
|
5752
|
+
}, {
|
|
5753
|
+
"in" : "query",
|
|
5754
|
+
"name" : "granularity",
|
|
5755
|
+
"required" : false,
|
|
5756
|
+
"schema" : {
|
|
5757
|
+
"default" : "day",
|
|
5758
|
+
"enum" : [ "hour", "day", "week" ],
|
|
5289
5759
|
"type" : "string"
|
|
5290
5760
|
}
|
|
5291
5761
|
} ],
|
|
@@ -5294,42 +5764,43 @@
|
|
|
5294
5764
|
"content" : {
|
|
5295
5765
|
"application/json" : {
|
|
5296
5766
|
"schema" : {
|
|
5297
|
-
"
|
|
5298
|
-
"$ref" : "#/components/schemas/Metric"
|
|
5299
|
-
},
|
|
5300
|
-
"type" : "array"
|
|
5767
|
+
"$ref" : "#/components/schemas/EphemeralInstancesMetricsResponse"
|
|
5301
5768
|
}
|
|
5302
5769
|
}
|
|
5303
5770
|
},
|
|
5304
|
-
"description" : "
|
|
5305
|
-
},
|
|
5306
|
-
"400" : {
|
|
5307
|
-
"description" : "Invalid date format"
|
|
5771
|
+
"description" : "Ephemeral instances metrics retrieved successfully"
|
|
5308
5772
|
},
|
|
5309
5773
|
"401" : {
|
|
5310
5774
|
"description" : "Unauthorized"
|
|
5311
5775
|
},
|
|
5312
5776
|
"403" : {
|
|
5313
|
-
"description" : "Forbidden
|
|
5777
|
+
"description" : "Forbidden"
|
|
5314
5778
|
},
|
|
5315
5779
|
"500" : {
|
|
5316
5780
|
"description" : "Server error"
|
|
5317
5781
|
}
|
|
5318
5782
|
},
|
|
5319
|
-
"summary" : "Get
|
|
5783
|
+
"summary" : "Get ephemeral instances metrics for an organization",
|
|
5320
5784
|
"tags" : [ "metrics" ]
|
|
5321
5785
|
}
|
|
5322
5786
|
},
|
|
5323
|
-
"/metrics/
|
|
5787
|
+
"/metrics/organizations/{organizationId}/usage" : {
|
|
5324
5788
|
"get" : {
|
|
5325
|
-
"description" : "
|
|
5326
|
-
"operationId" : "
|
|
5789
|
+
"description" : "Returns LLM requests and token usage over time for all agents in the organization",
|
|
5790
|
+
"operationId" : "getMetricsOrganizationUsage",
|
|
5327
5791
|
"parameters" : [ {
|
|
5792
|
+
"description" : "ID of the organization",
|
|
5793
|
+
"in" : "path",
|
|
5794
|
+
"name" : "organizationId",
|
|
5795
|
+
"required" : true,
|
|
5796
|
+
"schema" : {
|
|
5797
|
+
"type" : "string"
|
|
5798
|
+
}
|
|
5799
|
+
}, {
|
|
5328
5800
|
"description" : "Start date for metrics (ISO format)",
|
|
5329
5801
|
"in" : "query",
|
|
5330
5802
|
"name" : "startDate",
|
|
5331
5803
|
"schema" : {
|
|
5332
|
-
"format" : "date-time",
|
|
5333
5804
|
"type" : "string"
|
|
5334
5805
|
}
|
|
5335
5806
|
}, {
|
|
@@ -5337,7 +5808,15 @@
|
|
|
5337
5808
|
"in" : "query",
|
|
5338
5809
|
"name" : "endDate",
|
|
5339
5810
|
"schema" : {
|
|
5340
|
-
"
|
|
5811
|
+
"type" : "string"
|
|
5812
|
+
}
|
|
5813
|
+
}, {
|
|
5814
|
+
"in" : "query",
|
|
5815
|
+
"name" : "granularity",
|
|
5816
|
+
"required" : false,
|
|
5817
|
+
"schema" : {
|
|
5818
|
+
"default" : "day",
|
|
5819
|
+
"enum" : [ "hour", "day", "week" ],
|
|
5341
5820
|
"type" : "string"
|
|
5342
5821
|
}
|
|
5343
5822
|
} ],
|
|
@@ -5346,29 +5825,23 @@
|
|
|
5346
5825
|
"content" : {
|
|
5347
5826
|
"application/json" : {
|
|
5348
5827
|
"schema" : {
|
|
5349
|
-
"
|
|
5350
|
-
"$ref" : "#/components/schemas/MetricForAgent"
|
|
5351
|
-
},
|
|
5352
|
-
"type" : "array"
|
|
5828
|
+
"$ref" : "#/components/schemas/OrgUsageMetricsResponse"
|
|
5353
5829
|
}
|
|
5354
5830
|
}
|
|
5355
5831
|
},
|
|
5356
|
-
"description" : "
|
|
5357
|
-
},
|
|
5358
|
-
"400" : {
|
|
5359
|
-
"description" : "Invalid date format"
|
|
5832
|
+
"description" : "Usage metrics retrieved successfully"
|
|
5360
5833
|
},
|
|
5361
5834
|
"401" : {
|
|
5362
5835
|
"description" : "Unauthorized"
|
|
5363
5836
|
},
|
|
5364
5837
|
"403" : {
|
|
5365
|
-
"description" : "Forbidden
|
|
5838
|
+
"description" : "Forbidden"
|
|
5366
5839
|
},
|
|
5367
5840
|
"500" : {
|
|
5368
5841
|
"description" : "Server error"
|
|
5369
5842
|
}
|
|
5370
5843
|
},
|
|
5371
|
-
"summary" : "Get
|
|
5844
|
+
"summary" : "Get usage metrics for an organization",
|
|
5372
5845
|
"tags" : [ "metrics" ]
|
|
5373
5846
|
}
|
|
5374
5847
|
},
|
|
@@ -6658,6 +7131,56 @@
|
|
|
6658
7131
|
"tags" : [ "organizations" ]
|
|
6659
7132
|
}
|
|
6660
7133
|
},
|
|
7134
|
+
"/organizations/{organizationId}/metrics/agents/{agentId}" : {
|
|
7135
|
+
"get" : {
|
|
7136
|
+
"description" : "Retrieves metrics for a brain agent",
|
|
7137
|
+
"operationId" : "getMetricsBrainsAgent",
|
|
7138
|
+
"parameters" : [ {
|
|
7139
|
+
"description" : "ID of the organization",
|
|
7140
|
+
"in" : "path",
|
|
7141
|
+
"name" : "organizationId",
|
|
7142
|
+
"required" : true,
|
|
7143
|
+
"schema" : {
|
|
7144
|
+
"type" : "string"
|
|
7145
|
+
}
|
|
7146
|
+
}, {
|
|
7147
|
+
"description" : "ID of the agent",
|
|
7148
|
+
"in" : "path",
|
|
7149
|
+
"name" : "agentId",
|
|
7150
|
+
"required" : true,
|
|
7151
|
+
"schema" : {
|
|
7152
|
+
"format" : "uuid",
|
|
7153
|
+
"type" : "string"
|
|
7154
|
+
}
|
|
7155
|
+
} ],
|
|
7156
|
+
"responses" : {
|
|
7157
|
+
"200" : {
|
|
7158
|
+
"content" : {
|
|
7159
|
+
"application/json" : {
|
|
7160
|
+
"schema" : {
|
|
7161
|
+
"$ref" : "#/components/schemas/MetricsBrainsAgentResponse"
|
|
7162
|
+
}
|
|
7163
|
+
}
|
|
7164
|
+
},
|
|
7165
|
+
"description" : "Metrics for a brain agent found"
|
|
7166
|
+
},
|
|
7167
|
+
"401" : {
|
|
7168
|
+
"description" : "Unauthorized"
|
|
7169
|
+
},
|
|
7170
|
+
"403" : {
|
|
7171
|
+
"description" : "Forbidden - User doesn't have access to the organization"
|
|
7172
|
+
},
|
|
7173
|
+
"404" : {
|
|
7174
|
+
"description" : "Metrics for a brain agent not found"
|
|
7175
|
+
},
|
|
7176
|
+
"500" : {
|
|
7177
|
+
"description" : "Server error"
|
|
7178
|
+
}
|
|
7179
|
+
},
|
|
7180
|
+
"summary" : "Get metrics for a brain agent",
|
|
7181
|
+
"tags" : [ "metrics" ]
|
|
7182
|
+
}
|
|
7183
|
+
},
|
|
6661
7184
|
"/manifests" : {
|
|
6662
7185
|
"get" : {
|
|
6663
7186
|
"description" : "Retrieves manifests, filtered by user ID for non-admin users",
|
|
@@ -10882,7 +11405,6 @@
|
|
|
10882
11405
|
"in" : "query",
|
|
10883
11406
|
"name" : "startDate",
|
|
10884
11407
|
"schema" : {
|
|
10885
|
-
"format" : "date-time",
|
|
10886
11408
|
"type" : "string"
|
|
10887
11409
|
}
|
|
10888
11410
|
},
|
|
@@ -10891,7 +11413,6 @@
|
|
|
10891
11413
|
"in" : "query",
|
|
10892
11414
|
"name" : "endDate",
|
|
10893
11415
|
"schema" : {
|
|
10894
|
-
"format" : "date-time",
|
|
10895
11416
|
"type" : "string"
|
|
10896
11417
|
}
|
|
10897
11418
|
},
|
|
@@ -11180,6 +11701,18 @@
|
|
|
11180
11701
|
"type" : "string"
|
|
11181
11702
|
}
|
|
11182
11703
|
},
|
|
11704
|
+
"agentsIds" : {
|
|
11705
|
+
"description" : "Agents IDs to filter metrics",
|
|
11706
|
+
"in" : "query",
|
|
11707
|
+
"name" : "agentsIds",
|
|
11708
|
+
"schema" : {
|
|
11709
|
+
"items" : {
|
|
11710
|
+
"format" : "uuid",
|
|
11711
|
+
"type" : "string"
|
|
11712
|
+
},
|
|
11713
|
+
"type" : "array"
|
|
11714
|
+
}
|
|
11715
|
+
},
|
|
11183
11716
|
"guardianIdPath" : {
|
|
11184
11717
|
"description" : "ID of the guardian",
|
|
11185
11718
|
"in" : "path",
|
|
@@ -11978,44 +12511,235 @@
|
|
|
11978
12511
|
"additionalProperties" : true,
|
|
11979
12512
|
"type" : "object"
|
|
11980
12513
|
},
|
|
11981
|
-
"restricted" : {
|
|
11982
|
-
"type" : "boolean"
|
|
12514
|
+
"restricted" : {
|
|
12515
|
+
"type" : "boolean"
|
|
12516
|
+
}
|
|
12517
|
+
},
|
|
12518
|
+
"required" : [ "configuration", "name", "type" ],
|
|
12519
|
+
"type" : "object"
|
|
12520
|
+
},
|
|
12521
|
+
"AgentMetricsOverview" : {
|
|
12522
|
+
"properties" : {
|
|
12523
|
+
"textConversationCount" : {
|
|
12524
|
+
"type" : "number"
|
|
12525
|
+
},
|
|
12526
|
+
"voiceConversationCount" : {
|
|
12527
|
+
"type" : "number"
|
|
12528
|
+
},
|
|
12529
|
+
"userTextMessagesCount" : {
|
|
12530
|
+
"type" : "number"
|
|
12531
|
+
},
|
|
12532
|
+
"userVoiceMessagesCount" : {
|
|
12533
|
+
"type" : "number"
|
|
12534
|
+
},
|
|
12535
|
+
"totalRequests" : {
|
|
12536
|
+
"type" : "number"
|
|
12537
|
+
},
|
|
12538
|
+
"totalTokensUsed" : {
|
|
12539
|
+
"type" : "number"
|
|
12540
|
+
},
|
|
12541
|
+
"ephemeralInstancesCreated" : {
|
|
12542
|
+
"type" : "number"
|
|
12543
|
+
},
|
|
12544
|
+
"uniqueUsersCount" : {
|
|
12545
|
+
"type" : "number"
|
|
12546
|
+
},
|
|
12547
|
+
"errorConversationCount" : {
|
|
12548
|
+
"type" : "number"
|
|
12549
|
+
},
|
|
12550
|
+
"tokenBreakdown" : {
|
|
12551
|
+
"$ref" : "#/components/schemas/AgentTokenBreakdown"
|
|
12552
|
+
},
|
|
12553
|
+
"tokenUsageByTask" : {
|
|
12554
|
+
"items" : {
|
|
12555
|
+
"$ref" : "#/components/schemas/AgentTokenUsageByTask"
|
|
12556
|
+
},
|
|
12557
|
+
"type" : "array"
|
|
12558
|
+
},
|
|
12559
|
+
"feedback" : {
|
|
12560
|
+
"$ref" : "#/components/schemas/AgentFeedbackMetrics"
|
|
12561
|
+
},
|
|
12562
|
+
"metricsByApp" : {
|
|
12563
|
+
"items" : {
|
|
12564
|
+
"$ref" : "#/components/schemas/AgentMetricsByApp"
|
|
12565
|
+
},
|
|
12566
|
+
"type" : "array"
|
|
12567
|
+
},
|
|
12568
|
+
"topTools" : {
|
|
12569
|
+
"items" : {
|
|
12570
|
+
"$ref" : "#/components/schemas/AgentToolUsageMetric"
|
|
12571
|
+
},
|
|
12572
|
+
"type" : "array"
|
|
12573
|
+
},
|
|
12574
|
+
"periodComparison" : {
|
|
12575
|
+
"$ref" : "#/components/schemas/AgentMetricsPeriodComparison"
|
|
12576
|
+
},
|
|
12577
|
+
"tokenUsage" : {
|
|
12578
|
+
"items" : {
|
|
12579
|
+
"$ref" : "#/components/schemas/AgentTokenUsageMetric"
|
|
12580
|
+
},
|
|
12581
|
+
"type" : "array"
|
|
12582
|
+
},
|
|
12583
|
+
"subscription" : {
|
|
12584
|
+
"$ref" : "#/components/schemas/SubscriptionMetric"
|
|
12585
|
+
},
|
|
12586
|
+
"costs" : {
|
|
12587
|
+
"$ref" : "#/components/schemas/CostMetric"
|
|
12588
|
+
}
|
|
12589
|
+
},
|
|
12590
|
+
"required" : [ "textConversationCount", "userTextMessagesCount", "userVoiceMessagesCount", "voiceConversationCount" ],
|
|
12591
|
+
"type" : "object"
|
|
12592
|
+
},
|
|
12593
|
+
"AgentTokenBreakdown" : {
|
|
12594
|
+
"properties" : {
|
|
12595
|
+
"inputTokens" : {
|
|
12596
|
+
"type" : "number"
|
|
12597
|
+
},
|
|
12598
|
+
"outputTokens" : {
|
|
12599
|
+
"type" : "number"
|
|
12600
|
+
},
|
|
12601
|
+
"reasoningTokens" : {
|
|
12602
|
+
"type" : "number"
|
|
12603
|
+
}
|
|
12604
|
+
},
|
|
12605
|
+
"required" : [ "inputTokens", "outputTokens", "reasoningTokens" ],
|
|
12606
|
+
"type" : "object"
|
|
12607
|
+
},
|
|
12608
|
+
"AgentTokenUsageByTask" : {
|
|
12609
|
+
"properties" : {
|
|
12610
|
+
"task" : {
|
|
12611
|
+
"type" : "string"
|
|
12612
|
+
},
|
|
12613
|
+
"total" : {
|
|
12614
|
+
"type" : "number"
|
|
12615
|
+
}
|
|
12616
|
+
},
|
|
12617
|
+
"required" : [ "task", "total" ],
|
|
12618
|
+
"type" : "object"
|
|
12619
|
+
},
|
|
12620
|
+
"AgentFeedbackMetrics" : {
|
|
12621
|
+
"properties" : {
|
|
12622
|
+
"positive" : {
|
|
12623
|
+
"type" : "number"
|
|
12624
|
+
},
|
|
12625
|
+
"negative" : {
|
|
12626
|
+
"type" : "number"
|
|
12627
|
+
},
|
|
12628
|
+
"total" : {
|
|
12629
|
+
"type" : "number"
|
|
12630
|
+
},
|
|
12631
|
+
"satisfactionRate" : {
|
|
12632
|
+
"type" : "number"
|
|
12633
|
+
}
|
|
12634
|
+
},
|
|
12635
|
+
"required" : [ "negative", "positive", "total" ],
|
|
12636
|
+
"type" : "object"
|
|
12637
|
+
},
|
|
12638
|
+
"AgentMetricsByApp" : {
|
|
12639
|
+
"properties" : {
|
|
12640
|
+
"appId" : {
|
|
12641
|
+
"nullable" : true,
|
|
12642
|
+
"type" : "string"
|
|
12643
|
+
},
|
|
12644
|
+
"appName" : {
|
|
12645
|
+
"type" : "string"
|
|
12646
|
+
},
|
|
12647
|
+
"tokens" : {
|
|
12648
|
+
"type" : "number"
|
|
12649
|
+
},
|
|
12650
|
+
"conversations" : {
|
|
12651
|
+
"type" : "number"
|
|
12652
|
+
},
|
|
12653
|
+
"uniqueUsers" : {
|
|
12654
|
+
"type" : "number"
|
|
12655
|
+
}
|
|
12656
|
+
},
|
|
12657
|
+
"required" : [ "appName", "conversations", "tokens", "uniqueUsers" ],
|
|
12658
|
+
"type" : "object"
|
|
12659
|
+
},
|
|
12660
|
+
"AgentToolUsageMetric" : {
|
|
12661
|
+
"properties" : {
|
|
12662
|
+
"toolName" : {
|
|
12663
|
+
"type" : "string"
|
|
12664
|
+
},
|
|
12665
|
+
"count" : {
|
|
12666
|
+
"type" : "number"
|
|
12667
|
+
}
|
|
12668
|
+
},
|
|
12669
|
+
"required" : [ "count", "toolName" ],
|
|
12670
|
+
"type" : "object"
|
|
12671
|
+
},
|
|
12672
|
+
"AgentMetricsPeriodComparison" : {
|
|
12673
|
+
"properties" : {
|
|
12674
|
+
"previous" : {
|
|
12675
|
+
"$ref" : "#/components/schemas/AgentMetricsPeriodSnapshot"
|
|
12676
|
+
},
|
|
12677
|
+
"deltaPercent" : {
|
|
12678
|
+
"additionalProperties" : {
|
|
12679
|
+
"nullable" : true,
|
|
12680
|
+
"type" : "number"
|
|
12681
|
+
},
|
|
12682
|
+
"type" : "object"
|
|
11983
12683
|
}
|
|
11984
12684
|
},
|
|
11985
|
-
"required" : [ "
|
|
12685
|
+
"required" : [ "deltaPercent", "previous" ],
|
|
11986
12686
|
"type" : "object"
|
|
11987
12687
|
},
|
|
11988
|
-
"
|
|
12688
|
+
"AgentMetricsPeriodSnapshot" : {
|
|
11989
12689
|
"properties" : {
|
|
11990
|
-
"
|
|
12690
|
+
"totalRequests" : {
|
|
11991
12691
|
"type" : "number"
|
|
11992
12692
|
},
|
|
11993
|
-
"
|
|
12693
|
+
"totalTokensUsed" : {
|
|
11994
12694
|
"type" : "number"
|
|
11995
12695
|
},
|
|
11996
|
-
"
|
|
12696
|
+
"conversations" : {
|
|
11997
12697
|
"type" : "number"
|
|
11998
12698
|
},
|
|
11999
|
-
"
|
|
12699
|
+
"uniqueUsersCount" : {
|
|
12000
12700
|
"type" : "number"
|
|
12001
12701
|
},
|
|
12002
|
-
"
|
|
12003
|
-
"
|
|
12702
|
+
"ephemeralInstancesCreated" : {
|
|
12703
|
+
"type" : "number"
|
|
12004
12704
|
},
|
|
12005
|
-
"
|
|
12006
|
-
"
|
|
12705
|
+
"errorConversationCount" : {
|
|
12706
|
+
"type" : "number"
|
|
12707
|
+
},
|
|
12708
|
+
"feedbackPositive" : {
|
|
12709
|
+
"type" : "number"
|
|
12007
12710
|
}
|
|
12008
12711
|
},
|
|
12009
|
-
"required" : [ "
|
|
12712
|
+
"required" : [ "conversations", "ephemeralInstancesCreated", "errorConversationCount", "feedbackPositive", "totalRequests", "totalTokensUsed", "uniqueUsersCount" ],
|
|
12713
|
+
"type" : "object"
|
|
12714
|
+
},
|
|
12715
|
+
"AgentTokenUsageMetric" : {
|
|
12716
|
+
"properties" : {
|
|
12717
|
+
"provider" : {
|
|
12718
|
+
"type" : "string"
|
|
12719
|
+
},
|
|
12720
|
+
"model" : {
|
|
12721
|
+
"type" : "string"
|
|
12722
|
+
},
|
|
12723
|
+
"type" : {
|
|
12724
|
+
"type" : "string"
|
|
12725
|
+
},
|
|
12726
|
+
"units" : {
|
|
12727
|
+
"type" : "string"
|
|
12728
|
+
},
|
|
12729
|
+
"total" : {
|
|
12730
|
+
"type" : "number"
|
|
12731
|
+
}
|
|
12732
|
+
},
|
|
12733
|
+
"required" : [ "model", "provider", "total", "type", "units" ],
|
|
12010
12734
|
"type" : "object"
|
|
12011
12735
|
},
|
|
12012
12736
|
"SubscriptionMetric" : {
|
|
12013
12737
|
"properties" : {
|
|
12014
12738
|
"textInteractions" : {
|
|
12015
|
-
"
|
|
12739
|
+
"$ref" : "#/components/schemas/SubscriptionInteractionsMetric"
|
|
12016
12740
|
},
|
|
12017
12741
|
"voiceInteractions" : {
|
|
12018
|
-
"
|
|
12742
|
+
"$ref" : "#/components/schemas/SubscriptionInteractionsMetric"
|
|
12019
12743
|
},
|
|
12020
12744
|
"canGoBeyondIncluded" : {
|
|
12021
12745
|
"type" : "boolean"
|
|
@@ -12027,6 +12751,34 @@
|
|
|
12027
12751
|
"type" : "string"
|
|
12028
12752
|
}
|
|
12029
12753
|
},
|
|
12754
|
+
"required" : [ "canGoBeyondIncluded", "textInteractions", "voiceInteractions" ],
|
|
12755
|
+
"type" : "object"
|
|
12756
|
+
},
|
|
12757
|
+
"SubscriptionInteractionsMetric" : {
|
|
12758
|
+
"properties" : {
|
|
12759
|
+
"included" : {
|
|
12760
|
+
"type" : "number"
|
|
12761
|
+
},
|
|
12762
|
+
"additional" : {
|
|
12763
|
+
"$ref" : "#/components/schemas/SubscriptionAdditionalMetric"
|
|
12764
|
+
}
|
|
12765
|
+
},
|
|
12766
|
+
"required" : [ "additional", "included" ],
|
|
12767
|
+
"type" : "object"
|
|
12768
|
+
},
|
|
12769
|
+
"SubscriptionAdditionalMetric" : {
|
|
12770
|
+
"properties" : {
|
|
12771
|
+
"price" : {
|
|
12772
|
+
"type" : "string"
|
|
12773
|
+
},
|
|
12774
|
+
"amountForPrice" : {
|
|
12775
|
+
"type" : "string"
|
|
12776
|
+
},
|
|
12777
|
+
"currency" : {
|
|
12778
|
+
"type" : "string"
|
|
12779
|
+
}
|
|
12780
|
+
},
|
|
12781
|
+
"required" : [ "amountForPrice", "currency", "price" ],
|
|
12030
12782
|
"type" : "object"
|
|
12031
12783
|
},
|
|
12032
12784
|
"CostMetric" : {
|
|
@@ -12056,6 +12808,69 @@
|
|
|
12056
12808
|
"required" : [ "amount", "currency" ],
|
|
12057
12809
|
"type" : "object"
|
|
12058
12810
|
},
|
|
12811
|
+
"EphemeralInstancesMetricsResponse" : {
|
|
12812
|
+
"properties" : {
|
|
12813
|
+
"total" : {
|
|
12814
|
+
"type" : "number"
|
|
12815
|
+
},
|
|
12816
|
+
"series" : {
|
|
12817
|
+
"items" : {
|
|
12818
|
+
"$ref" : "#/components/schemas/EphemeralInstancesTimeSeriesPoint"
|
|
12819
|
+
},
|
|
12820
|
+
"type" : "array"
|
|
12821
|
+
}
|
|
12822
|
+
},
|
|
12823
|
+
"required" : [ "series", "total" ],
|
|
12824
|
+
"type" : "object"
|
|
12825
|
+
},
|
|
12826
|
+
"EphemeralInstancesTimeSeriesPoint" : {
|
|
12827
|
+
"properties" : {
|
|
12828
|
+
"bucket" : {
|
|
12829
|
+
"type" : "string"
|
|
12830
|
+
},
|
|
12831
|
+
"label" : {
|
|
12832
|
+
"type" : "string"
|
|
12833
|
+
},
|
|
12834
|
+
"count" : {
|
|
12835
|
+
"type" : "number"
|
|
12836
|
+
}
|
|
12837
|
+
},
|
|
12838
|
+
"required" : [ "bucket", "count", "label" ],
|
|
12839
|
+
"type" : "object"
|
|
12840
|
+
},
|
|
12841
|
+
"OrgUsageMetricsResponse" : {
|
|
12842
|
+
"properties" : {
|
|
12843
|
+
"total" : {
|
|
12844
|
+
"$ref" : "#/components/schemas/OrgUsageMetricsResponse_total"
|
|
12845
|
+
},
|
|
12846
|
+
"series" : {
|
|
12847
|
+
"items" : {
|
|
12848
|
+
"$ref" : "#/components/schemas/OrgUsageTimeSeriesPoint"
|
|
12849
|
+
},
|
|
12850
|
+
"type" : "array"
|
|
12851
|
+
}
|
|
12852
|
+
},
|
|
12853
|
+
"required" : [ "series", "total" ],
|
|
12854
|
+
"type" : "object"
|
|
12855
|
+
},
|
|
12856
|
+
"OrgUsageTimeSeriesPoint" : {
|
|
12857
|
+
"properties" : {
|
|
12858
|
+
"bucket" : {
|
|
12859
|
+
"type" : "string"
|
|
12860
|
+
},
|
|
12861
|
+
"label" : {
|
|
12862
|
+
"type" : "string"
|
|
12863
|
+
},
|
|
12864
|
+
"requests" : {
|
|
12865
|
+
"type" : "number"
|
|
12866
|
+
},
|
|
12867
|
+
"tokens" : {
|
|
12868
|
+
"type" : "number"
|
|
12869
|
+
}
|
|
12870
|
+
},
|
|
12871
|
+
"required" : [ "bucket", "label", "requests", "tokens" ],
|
|
12872
|
+
"type" : "object"
|
|
12873
|
+
},
|
|
12059
12874
|
"AgentUsageMetrics" : {
|
|
12060
12875
|
"properties" : {
|
|
12061
12876
|
"_id" : {
|
|
@@ -14545,6 +15360,9 @@
|
|
|
14545
15360
|
},
|
|
14546
15361
|
"count" : {
|
|
14547
15362
|
"type" : "number"
|
|
15363
|
+
},
|
|
15364
|
+
"timestamp" : {
|
|
15365
|
+
"type" : "string"
|
|
14548
15366
|
}
|
|
14549
15367
|
},
|
|
14550
15368
|
"required" : [ "count", "identifier", "total" ],
|
|
@@ -14629,6 +15447,46 @@
|
|
|
14629
15447
|
"required" : [ "model", "provider", "total", "type", "units" ],
|
|
14630
15448
|
"type" : "object"
|
|
14631
15449
|
},
|
|
15450
|
+
"MetricForDay" : {
|
|
15451
|
+
"items" : {
|
|
15452
|
+
"$ref" : "#/components/schemas/MetricForDay_inner"
|
|
15453
|
+
},
|
|
15454
|
+
"type" : "array"
|
|
15455
|
+
},
|
|
15456
|
+
"MetricsUsersResponse" : {
|
|
15457
|
+
"properties" : {
|
|
15458
|
+
"usersToday" : {
|
|
15459
|
+
"$ref" : "#/components/schemas/MetricForVisitorToday"
|
|
15460
|
+
},
|
|
15461
|
+
"usersByMonth" : {
|
|
15462
|
+
"$ref" : "#/components/schemas/MetricForVisitorByMonth"
|
|
15463
|
+
}
|
|
15464
|
+
},
|
|
15465
|
+
"required" : [ "usersByMonth", "usersToday" ],
|
|
15466
|
+
"type" : "object"
|
|
15467
|
+
},
|
|
15468
|
+
"MetricForVisitorToday" : {
|
|
15469
|
+
"type" : "number"
|
|
15470
|
+
},
|
|
15471
|
+
"MetricForVisitorByMonth" : {
|
|
15472
|
+
"items" : {
|
|
15473
|
+
"$ref" : "#/components/schemas/MetricForVisitorByMonth_inner"
|
|
15474
|
+
},
|
|
15475
|
+
"type" : "array"
|
|
15476
|
+
},
|
|
15477
|
+
"MetricsTopAgentsResponse" : {
|
|
15478
|
+
"items" : {
|
|
15479
|
+
"$ref" : "#/components/schemas/MetricsTopAgentsResponse_inner"
|
|
15480
|
+
},
|
|
15481
|
+
"required" : [ "agentId", "agentName", "errorConversationCount", "textConversationCount" ],
|
|
15482
|
+
"type" : "array"
|
|
15483
|
+
},
|
|
15484
|
+
"MetricsTopAgentsUsageResponse" : {
|
|
15485
|
+
"items" : {
|
|
15486
|
+
"$ref" : "#/components/schemas/MetricsTopAgentsUsageResponse_inner"
|
|
15487
|
+
},
|
|
15488
|
+
"type" : "array"
|
|
15489
|
+
},
|
|
14632
15490
|
"Guardian" : {
|
|
14633
15491
|
"properties" : {
|
|
14634
15492
|
"id" : {
|
|
@@ -15087,6 +15945,44 @@
|
|
|
15087
15945
|
},
|
|
15088
15946
|
"type" : "object"
|
|
15089
15947
|
},
|
|
15948
|
+
"MetricsBrainsAgentResponse" : {
|
|
15949
|
+
"properties" : {
|
|
15950
|
+
"conversationCount" : {
|
|
15951
|
+
"$ref" : "#/components/schemas/ConversationCount"
|
|
15952
|
+
},
|
|
15953
|
+
"usersCount" : {
|
|
15954
|
+
"$ref" : "#/components/schemas/UsersCount"
|
|
15955
|
+
},
|
|
15956
|
+
"totalTokensUsedByAgent" : {
|
|
15957
|
+
"$ref" : "#/components/schemas/TotalTokensUsedByAgent"
|
|
15958
|
+
},
|
|
15959
|
+
"totalRequests" : {
|
|
15960
|
+
"$ref" : "#/components/schemas/TotalRequests"
|
|
15961
|
+
}
|
|
15962
|
+
},
|
|
15963
|
+
"required" : [ "conversationCount", "totalRequests", "totalTokensUsedByAgent", "usersCount" ],
|
|
15964
|
+
"type" : "object"
|
|
15965
|
+
},
|
|
15966
|
+
"ConversationCount" : {
|
|
15967
|
+
"type" : "number"
|
|
15968
|
+
},
|
|
15969
|
+
"UsersCount" : {
|
|
15970
|
+
"type" : "number"
|
|
15971
|
+
},
|
|
15972
|
+
"TotalTokensUsedByAgent" : {
|
|
15973
|
+
"properties" : {
|
|
15974
|
+
"name" : {
|
|
15975
|
+
"type" : "string"
|
|
15976
|
+
},
|
|
15977
|
+
"totalTokens" : {
|
|
15978
|
+
"type" : "number"
|
|
15979
|
+
}
|
|
15980
|
+
},
|
|
15981
|
+
"type" : "object"
|
|
15982
|
+
},
|
|
15983
|
+
"TotalRequests" : {
|
|
15984
|
+
"type" : "number"
|
|
15985
|
+
},
|
|
15090
15986
|
"Manifest" : {
|
|
15091
15987
|
"additionalProperties" : true,
|
|
15092
15988
|
"properties" : {
|
|
@@ -15270,6 +16166,14 @@
|
|
|
15270
16166
|
"nullable" : true,
|
|
15271
16167
|
"type" : "number"
|
|
15272
16168
|
},
|
|
16169
|
+
"isChunkingEnriched" : {
|
|
16170
|
+
"nullable" : true,
|
|
16171
|
+
"type" : "boolean"
|
|
16172
|
+
},
|
|
16173
|
+
"boostScore" : {
|
|
16174
|
+
"nullable" : true,
|
|
16175
|
+
"type" : "number"
|
|
16176
|
+
},
|
|
15273
16177
|
"vectorizerModel" : {
|
|
15274
16178
|
"nullable" : true,
|
|
15275
16179
|
"type" : "string"
|
|
@@ -16236,7 +17140,7 @@
|
|
|
16236
17140
|
"type" : "string"
|
|
16237
17141
|
},
|
|
16238
17142
|
"AgentMetricsUnitsType" : {
|
|
16239
|
-
"enum" : [ "TOKENS", "CURRENCY", "MILLISECONDS", "CHARACTERS" ],
|
|
17143
|
+
"enum" : [ "TOKENS", "CURRENCY", "MILLISECONDS", "CHARACTERS", "COUNT" ],
|
|
16240
17144
|
"type" : "string"
|
|
16241
17145
|
},
|
|
16242
17146
|
"ChatMessageRole" : {
|
|
@@ -16542,6 +17446,10 @@
|
|
|
16542
17446
|
"score" : {
|
|
16543
17447
|
"type" : "number"
|
|
16544
17448
|
},
|
|
17449
|
+
"breadcrumb" : {
|
|
17450
|
+
"nullable" : true,
|
|
17451
|
+
"type" : "string"
|
|
17452
|
+
},
|
|
16545
17453
|
"file" : {
|
|
16546
17454
|
"additionalProperties" : true,
|
|
16547
17455
|
"type" : "object"
|
|
@@ -16940,6 +17848,18 @@
|
|
|
16940
17848
|
"required" : [ "model", "providerId" ],
|
|
16941
17849
|
"type" : "object"
|
|
16942
17850
|
},
|
|
17851
|
+
"OrgUsageMetricsResponse_total" : {
|
|
17852
|
+
"properties" : {
|
|
17853
|
+
"requests" : {
|
|
17854
|
+
"type" : "number"
|
|
17855
|
+
},
|
|
17856
|
+
"tokens" : {
|
|
17857
|
+
"type" : "number"
|
|
17858
|
+
}
|
|
17859
|
+
},
|
|
17860
|
+
"required" : [ "requests", "tokens" ],
|
|
17861
|
+
"type" : "object"
|
|
17862
|
+
},
|
|
16943
17863
|
"FlowContents_text" : {
|
|
16944
17864
|
"anyOf" : [ {
|
|
16945
17865
|
"type" : "string"
|
|
@@ -17173,6 +18093,7 @@
|
|
|
17173
18093
|
"type" : "number"
|
|
17174
18094
|
}
|
|
17175
18095
|
},
|
|
18096
|
+
"required" : [ "allowed", "maxInstances" ],
|
|
17176
18097
|
"type" : "object"
|
|
17177
18098
|
},
|
|
17178
18099
|
"App_commands_inner" : {
|
|
@@ -17613,6 +18534,93 @@
|
|
|
17613
18534
|
"required" : [ "id" ],
|
|
17614
18535
|
"type" : "object"
|
|
17615
18536
|
},
|
|
18537
|
+
"MetricForDay_inner__id" : {
|
|
18538
|
+
"properties" : {
|
|
18539
|
+
"agentId" : {
|
|
18540
|
+
"format" : "uuid",
|
|
18541
|
+
"type" : "string"
|
|
18542
|
+
},
|
|
18543
|
+
"type" : {
|
|
18544
|
+
"type" : "string"
|
|
18545
|
+
},
|
|
18546
|
+
"model" : {
|
|
18547
|
+
"type" : "string"
|
|
18548
|
+
},
|
|
18549
|
+
"provider" : {
|
|
18550
|
+
"type" : "string"
|
|
18551
|
+
},
|
|
18552
|
+
"units" : {
|
|
18553
|
+
"type" : "string"
|
|
18554
|
+
}
|
|
18555
|
+
},
|
|
18556
|
+
"type" : "object"
|
|
18557
|
+
},
|
|
18558
|
+
"MetricForDay_inner" : {
|
|
18559
|
+
"properties" : {
|
|
18560
|
+
"_id" : {
|
|
18561
|
+
"$ref" : "#/components/schemas/MetricForDay_inner__id"
|
|
18562
|
+
},
|
|
18563
|
+
"total" : {
|
|
18564
|
+
"type" : "number"
|
|
18565
|
+
},
|
|
18566
|
+
"count" : {
|
|
18567
|
+
"type" : "number"
|
|
18568
|
+
},
|
|
18569
|
+
"timestamp" : {
|
|
18570
|
+
"format" : "date-time",
|
|
18571
|
+
"type" : "string"
|
|
18572
|
+
}
|
|
18573
|
+
},
|
|
18574
|
+
"required" : [ "_id" ],
|
|
18575
|
+
"type" : "object"
|
|
18576
|
+
},
|
|
18577
|
+
"MetricForVisitorByMonth_inner" : {
|
|
18578
|
+
"properties" : {
|
|
18579
|
+
"date" : {
|
|
18580
|
+
"type" : "string"
|
|
18581
|
+
},
|
|
18582
|
+
"label" : {
|
|
18583
|
+
"type" : "string"
|
|
18584
|
+
},
|
|
18585
|
+
"users" : {
|
|
18586
|
+
"type" : "number"
|
|
18587
|
+
}
|
|
18588
|
+
},
|
|
18589
|
+
"required" : [ "date", "label", "users" ],
|
|
18590
|
+
"type" : "object"
|
|
18591
|
+
},
|
|
18592
|
+
"MetricsTopAgentsResponse_inner" : {
|
|
18593
|
+
"properties" : {
|
|
18594
|
+
"textConversationCount" : {
|
|
18595
|
+
"type" : "number"
|
|
18596
|
+
},
|
|
18597
|
+
"errorConversationCount" : {
|
|
18598
|
+
"type" : "number"
|
|
18599
|
+
},
|
|
18600
|
+
"agentId" : {
|
|
18601
|
+
"type" : "string"
|
|
18602
|
+
},
|
|
18603
|
+
"agentName" : {
|
|
18604
|
+
"type" : "string"
|
|
18605
|
+
}
|
|
18606
|
+
},
|
|
18607
|
+
"type" : "object"
|
|
18608
|
+
},
|
|
18609
|
+
"MetricsTopAgentsUsageResponse_inner" : {
|
|
18610
|
+
"properties" : {
|
|
18611
|
+
"agentId" : {
|
|
18612
|
+
"type" : "string"
|
|
18613
|
+
},
|
|
18614
|
+
"agentName" : {
|
|
18615
|
+
"type" : "string"
|
|
18616
|
+
},
|
|
18617
|
+
"usage" : {
|
|
18618
|
+
"type" : "number"
|
|
18619
|
+
}
|
|
18620
|
+
},
|
|
18621
|
+
"required" : [ "agentId", "agentName", "usage" ],
|
|
18622
|
+
"type" : "object"
|
|
18623
|
+
},
|
|
17616
18624
|
"KnowledgeFileSummary_knowledgeBaseId" : {
|
|
17617
18625
|
"oneOf" : [ {
|
|
17618
18626
|
"type" : "string"
|