agent-generator-cli 1.0.0 → 1.0.2

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.
Files changed (766) hide show
  1. package/README.md +2 -22
  2. package/install-extension.js +89 -0
  3. package/main.js +45 -7
  4. package/package.json +21 -8
  5. package/source/api-data-generators/.idea/api-data-generators.iml +9 -0
  6. package/source/api-data-generators/.idea/misc.xml +6 -0
  7. package/source/api-data-generators/.idea/modules.xml +8 -0
  8. package/source/api-data-generators/.idea/vcs.xml +6 -0
  9. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +318 -0
  10. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +32 -0
  11. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +21 -0
  12. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +18 -0
  13. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +39 -0
  14. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +157 -0
  15. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +46 -0
  16. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +16 -0
  17. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +33 -0
  18. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +13 -0
  19. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +91 -0
  20. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +18 -0
  21. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +42 -0
  22. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +92 -0
  23. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +51 -0
  24. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +11 -0
  25. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +41 -0
  26. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +18 -0
  27. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +76 -0
  28. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +51 -0
  29. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +25 -0
  30. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +26 -0
  31. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +18 -0
  32. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +17 -0
  33. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +17 -0
  34. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +21 -0
  35. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +32 -0
  36. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +43 -0
  37. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +631 -0
  38. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +70 -0
  39. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +294 -0
  40. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +58 -0
  41. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +74 -0
  42. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +11 -0
  43. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +24 -0
  44. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +259 -0
  45. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +6 -0
  46. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +14 -0
  47. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +19 -0
  48. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +265 -0
  49. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +48 -0
  50. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +47 -0
  51. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +14 -0
  52. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +52 -0
  53. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +33 -0
  54. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +45 -0
  55. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +38 -0
  56. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +50 -0
  57. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +22 -0
  58. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +217 -0
  59. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +30 -0
  60. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +31 -0
  61. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +36 -0
  62. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +32 -0
  63. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +49 -0
  64. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +66 -0
  65. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +294 -0
  66. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +150 -0
  67. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +238 -0
  68. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +147 -0
  69. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +56 -0
  70. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +397 -0
  71. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +1123 -0
  72. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +26 -0
  73. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +26 -0
  74. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +49 -0
  75. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +58 -0
  76. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +27 -0
  77. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +20 -0
  78. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +13 -0
  79. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +24 -0
  80. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +29 -0
  81. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +115 -0
  82. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +64 -0
  83. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +288 -0
  84. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +119 -0
  85. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +37 -0
  86. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +26 -0
  87. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +211 -0
  88. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +40 -0
  89. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +32 -0
  90. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +72 -0
  91. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +247 -0
  92. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +51 -0
  93. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +65 -0
  94. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +77 -0
  95. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +14 -0
  96. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +44 -0
  97. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +35 -0
  98. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +185 -0
  99. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +43 -0
  100. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +313 -0
  101. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +16 -0
  102. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +121 -0
  103. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +350 -0
  104. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +16 -0
  105. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +19 -0
  106. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +509 -0
  107. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +32 -0
  108. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +63 -0
  109. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +370 -0
  110. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +44 -0
  111. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +47 -0
  112. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +52 -0
  113. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +11 -0
  114. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +45 -0
  115. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +184 -0
  116. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +30 -0
  117. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +93 -0
  118. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +19 -0
  119. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +202 -0
  120. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +56 -0
  121. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +334 -0
  122. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +113 -0
  123. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +68 -0
  124. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +16 -0
  125. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +270 -0
  126. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +70 -0
  127. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +486 -0
  128. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +77 -0
  129. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +305 -0
  130. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +126 -0
  131. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +205 -0
  132. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +90 -0
  133. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +33 -0
  134. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +228 -0
  135. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +44 -0
  136. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +156 -0
  137. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +50 -0
  138. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +17 -0
  139. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +37 -0
  140. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +45 -0
  141. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +6 -0
  142. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +21 -0
  143. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +106 -0
  144. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +205 -0
  145. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +196 -0
  146. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +45 -0
  147. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +77 -0
  148. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +14 -0
  149. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +689 -0
  150. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +64 -0
  151. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +61 -0
  152. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +49 -0
  153. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +44 -0
  154. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +108 -0
  155. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +39 -0
  156. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +54 -0
  157. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +1031 -0
  158. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +564 -0
  159. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +36 -0
  160. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +180 -0
  161. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +60 -0
  162. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +26 -0
  163. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +240 -0
  164. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +16 -0
  165. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +216 -0
  166. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +168 -0
  167. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +29 -0
  168. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +98 -0
  169. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +11 -0
  170. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +93 -0
  171. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +34 -0
  172. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +18 -0
  173. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +25 -0
  174. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +65 -0
  175. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +155 -0
  176. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +92 -0
  177. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +22 -0
  178. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +19 -0
  179. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +143 -0
  180. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +39 -0
  181. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +312 -0
  182. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +35 -0
  183. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +16 -0
  184. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +32 -0
  185. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +297 -0
  186. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +38 -0
  187. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +56 -0
  188. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +149 -0
  189. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +77 -0
  190. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +52 -0
  191. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +229 -0
  192. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +16 -0
  193. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +90 -0
  194. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +25 -0
  195. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +66 -0
  196. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +49 -0
  197. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +23 -0
  198. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +131 -0
  199. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +214 -0
  200. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +30 -0
  201. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +173 -0
  202. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +21 -0
  203. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +93 -0
  204. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +103 -0
  205. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +503 -0
  206. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +19 -0
  207. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +334 -0
  208. package/source/api-data-generators/support/License/test_data_generation_configurations.json +60 -0
  209. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +72 -0
  210. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +34 -0
  211. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +184 -0
  212. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +32 -0
  213. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +38 -0
  214. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +38 -0
  215. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +50 -0
  216. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +16 -0
  217. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +96 -0
  218. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +26 -0
  219. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +19 -0
  220. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +20 -0
  221. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +27 -0
  222. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +19 -0
  223. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +29 -0
  224. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +79 -0
  225. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +109 -0
  226. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +66 -0
  227. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +113 -0
  228. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +28 -0
  229. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +17 -0
  230. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +54 -0
  231. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +54 -0
  232. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +77 -0
  233. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +14 -0
  234. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +32 -0
  235. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +66 -0
  236. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +64 -0
  237. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +32 -0
  238. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +196 -0
  239. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +48 -0
  240. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +59 -0
  241. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +37 -0
  242. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +239 -0
  243. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +52 -0
  244. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +52 -0
  245. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +538 -0
  246. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +28 -0
  247. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +100 -0
  248. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +29 -0
  249. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +84 -0
  250. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +58 -0
  251. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +50 -0
  252. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +29 -0
  253. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +22 -0
  254. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +42 -0
  255. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +92 -0
  256. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +46 -0
  257. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +50 -0
  258. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +22 -0
  259. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +203 -0
  260. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +172 -0
  261. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +182 -0
  262. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +636 -0
  263. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +32 -0
  264. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +32 -0
  265. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +62 -0
  266. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +24 -0
  267. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +164 -0
  268. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +21 -0
  269. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +60 -0
  270. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +51 -0
  271. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +40 -0
  272. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +47 -0
  273. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +22 -0
  274. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +223 -0
  275. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +22 -0
  276. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +76 -0
  277. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +104 -0
  278. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +43 -0
  279. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +65 -0
  280. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +29 -0
  281. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +97 -0
  282. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +219 -0
  283. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +42 -0
  284. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +45 -0
  285. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +87 -0
  286. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +27 -0
  287. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +115 -0
  288. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +72 -0
  289. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +383 -0
  290. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +694 -0
  291. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +66 -0
  292. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +58 -0
  293. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +82 -0
  294. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +43 -0
  295. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +65 -0
  296. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +16 -0
  297. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +99 -0
  298. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +475 -0
  299. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +110 -0
  300. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +48 -0
  301. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +91 -0
  302. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +46 -0
  303. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +68 -0
  304. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +54 -0
  305. package/source/api-data-generators/support/User/test_data_generation_configurations.json +100 -0
  306. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +49 -0
  307. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +19 -0
  308. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +19 -0
  309. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +321 -0
  310. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +501 -0
  311. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +166 -0
  312. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +26 -0
  313. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +38 -0
  314. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +22 -0
  315. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +19 -0
  316. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +22 -0
  317. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +33 -0
  318. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +71 -0
  319. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +859 -0
  320. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +26 -0
  321. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +652 -0
  322. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +21 -0
  323. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +50 -0
  324. package/source/openapi-specifications/v1.0/common/Common.json +587 -0
  325. package/source/openapi-specifications/v1.0/portal/Account.json +183 -0
  326. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +1103 -0
  327. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +133 -0
  328. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +712 -0
  329. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +91 -0
  330. package/source/openapi-specifications/v1.0/portal/Attachment.json +122 -0
  331. package/source/openapi-specifications/v1.0/portal/Captcha.json +334 -0
  332. package/source/openapi-specifications/v1.0/portal/Category.json +1061 -0
  333. package/source/openapi-specifications/v1.0/portal/Comment.json +1546 -0
  334. package/source/openapi-specifications/v1.0/portal/Community.json +235 -0
  335. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +296 -0
  336. package/source/openapi-specifications/v1.0/portal/Contact.json +536 -0
  337. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +163 -0
  338. package/source/openapi-specifications/v1.0/portal/Department.json +246 -0
  339. package/source/openapi-specifications/v1.0/portal/Extension.json +1122 -0
  340. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +96 -0
  341. package/source/openapi-specifications/v1.0/portal/Field.json +1239 -0
  342. package/source/openapi-specifications/v1.0/portal/FileExport.json +313 -0
  343. package/source/openapi-specifications/v1.0/portal/Followers.json +802 -0
  344. package/source/openapi-specifications/v1.0/portal/Gamification.json +819 -0
  345. package/source/openapi-specifications/v1.0/portal/HashTags.json +61 -0
  346. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +605 -0
  347. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +148 -0
  348. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +920 -0
  349. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +118 -0
  350. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +184 -0
  351. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +70 -0
  352. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +1310 -0
  353. package/source/openapi-specifications/v1.0/portal/KbCategory.json +1525 -0
  354. package/source/openapi-specifications/v1.0/portal/KbSection.json +515 -0
  355. package/source/openapi-specifications/v1.0/portal/Label.json +172 -0
  356. package/source/openapi-specifications/v1.0/portal/Layout.json +303 -0
  357. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +375 -0
  358. package/source/openapi-specifications/v1.0/portal/Mentions.json +580 -0
  359. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +699 -0
  360. package/source/openapi-specifications/v1.0/portal/Permalink.json +265 -0
  361. package/source/openapi-specifications/v1.0/portal/Placeholders.json +57 -0
  362. package/source/openapi-specifications/v1.0/portal/Product.json +401 -0
  363. package/source/openapi-specifications/v1.0/portal/Solution.json +3766 -0
  364. package/source/openapi-specifications/v1.0/portal/Thread.json +821 -0
  365. package/source/openapi-specifications/v1.0/portal/Ticket.json +2636 -0
  366. package/source/openapi-specifications/v1.0/portal/TicketComment.json +822 -0
  367. package/source/openapi-specifications/v1.0/portal/TicketCount.json +336 -0
  368. package/source/openapi-specifications/v1.0/portal/TicketExport.json +609 -0
  369. package/source/openapi-specifications/v1.0/portal/TicketField.json +358 -0
  370. package/source/openapi-specifications/v1.0/portal/TicketForm.json +517 -0
  371. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +155 -0
  372. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +409 -0
  373. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +175 -0
  374. package/source/openapi-specifications/v1.0/portal/Topic.json +4079 -0
  375. package/source/openapi-specifications/v1.0/portal/Translation.json +174 -0
  376. package/source/openapi-specifications/v1.0/portal/Upload.json +156 -0
  377. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +309 -0
  378. package/source/openapi-specifications/v1.0/portal/View.json +353 -0
  379. package/source/openapi-specifications/v1.0/portal/Widget.json +218 -0
  380. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +354 -0
  381. package/source/openapi-specifications/v1.0/support/Account.json +3206 -0
  382. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +484 -0
  383. package/source/openapi-specifications/v1.0/support/AccountComments.json +794 -0
  384. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +227 -0
  385. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +578 -0
  386. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +350 -0
  387. package/source/openapi-specifications/v1.0/support/AccountSla.json +341 -0
  388. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +1152 -0
  389. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +573 -0
  390. package/source/openapi-specifications/v1.0/support/Activity.json +1400 -0
  391. package/source/openapi-specifications/v1.0/support/Actor.json +88 -0
  392. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +304 -0
  393. package/source/openapi-specifications/v1.0/support/AdminTool.json +489 -0
  394. package/source/openapi-specifications/v1.0/support/Agent.json +6685 -0
  395. package/source/openapi-specifications/v1.0/support/AgentPresence.json +567 -0
  396. package/source/openapi-specifications/v1.0/support/AgentRoom.json +1997 -0
  397. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +359 -0
  398. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +1402 -0
  399. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +510 -0
  400. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +1189 -0
  401. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +543 -0
  402. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +155 -0
  403. package/source/openapi-specifications/v1.0/support/ArchivedView.json +469 -0
  404. package/source/openapi-specifications/v1.0/support/Article.json +5060 -0
  405. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +544 -0
  406. package/source/openapi-specifications/v1.0/support/ArticleComment.json +1929 -0
  407. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +56 -0
  408. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +1314 -0
  409. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +513 -0
  410. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +2510 -0
  411. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +3053 -0
  412. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +7530 -0
  413. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +184 -0
  414. package/source/openapi-specifications/v1.0/support/ArticleViews.json +564 -0
  415. package/source/openapi-specifications/v1.0/support/Asap.json +1525 -0
  416. package/source/openapi-specifications/v1.0/support/AsapModule.json +246 -0
  417. package/source/openapi-specifications/v1.0/support/AsapStatus.json +199 -0
  418. package/source/openapi-specifications/v1.0/support/AssistInteg.json +613 -0
  419. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +786 -0
  420. package/source/openapi-specifications/v1.0/support/AuditLog.json +1122 -0
  421. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +702 -0
  422. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +868 -0
  423. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +1181 -0
  424. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +207 -0
  425. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +809 -0
  426. package/source/openapi-specifications/v1.0/support/AutomationTask.json +1054 -0
  427. package/source/openapi-specifications/v1.0/support/Backup.json +2845 -0
  428. package/source/openapi-specifications/v1.0/support/Badge.json +544 -0
  429. package/source/openapi-specifications/v1.0/support/Bot.json +2103 -0
  430. package/source/openapi-specifications/v1.0/support/BotInference.json +1071 -0
  431. package/source/openapi-specifications/v1.0/support/BotResources.json +175 -0
  432. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +541 -0
  433. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +63 -0
  434. package/source/openapi-specifications/v1.0/support/Bots.json +58 -0
  435. package/source/openapi-specifications/v1.0/support/BugInteg.json +481 -0
  436. package/source/openapi-specifications/v1.0/support/BulkAction.json +150 -0
  437. package/source/openapi-specifications/v1.0/support/BulkImport.json +2845 -0
  438. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +743 -0
  439. package/source/openapi-specifications/v1.0/support/BulkWrite.json +678 -0
  440. package/source/openapi-specifications/v1.0/support/BusinessHour.json +1344 -0
  441. package/source/openapi-specifications/v1.0/support/Call.json +3839 -0
  442. package/source/openapi-specifications/v1.0/support/CallComments.json +721 -0
  443. package/source/openapi-specifications/v1.0/support/CallHistory.json +936 -0
  444. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +1745 -0
  445. package/source/openapi-specifications/v1.0/support/CallTimer.json +285 -0
  446. package/source/openapi-specifications/v1.0/support/Channel.json +730 -0
  447. package/source/openapi-specifications/v1.0/support/Chart.json +422 -0
  448. package/source/openapi-specifications/v1.0/support/ChatTicket.json +553 -0
  449. package/source/openapi-specifications/v1.0/support/ClientAction.json +1834 -0
  450. package/source/openapi-specifications/v1.0/support/ClientEvent.json +780 -0
  451. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +1123 -0
  452. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +528 -0
  453. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +44 -0
  454. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +94 -0
  455. package/source/openapi-specifications/v1.0/support/Community.json +2545 -0
  456. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +249 -0
  457. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +1896 -0
  458. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +145 -0
  459. package/source/openapi-specifications/v1.0/support/CommunityComment.json +2492 -0
  460. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +129 -0
  461. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +343 -0
  462. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +78 -0
  463. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +6005 -0
  464. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +310 -0
  465. package/source/openapi-specifications/v1.0/support/CommunityUser.json +822 -0
  466. package/source/openapi-specifications/v1.0/support/Composite.json +414 -0
  467. package/source/openapi-specifications/v1.0/support/Contact.json +4691 -0
  468. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +484 -0
  469. package/source/openapi-specifications/v1.0/support/ContactComments.json +769 -0
  470. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +683 -0
  471. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +350 -0
  472. package/source/openapi-specifications/v1.0/support/ContactProfile.json +195 -0
  473. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +1157 -0
  474. package/source/openapi-specifications/v1.0/support/Contract.json +2877 -0
  475. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +307 -0
  476. package/source/openapi-specifications/v1.0/support/Conversation.json +570 -0
  477. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +5279 -0
  478. package/source/openapi-specifications/v1.0/support/CreditCycle.json +124 -0
  479. package/source/openapi-specifications/v1.0/support/Criteria.json +1014 -0
  480. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +50 -0
  481. package/source/openapi-specifications/v1.0/support/CrmInteg.json +5938 -0
  482. package/source/openapi-specifications/v1.0/support/CustomAction.json +2106 -0
  483. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +1327 -0
  484. package/source/openapi-specifications/v1.0/support/CustomButton.json +1898 -0
  485. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +883 -0
  486. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +329 -0
  487. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +317 -0
  488. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +379 -0
  489. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +3457 -0
  490. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +81 -0
  491. package/source/openapi-specifications/v1.0/support/CustomTheme.json +7391 -0
  492. package/source/openapi-specifications/v1.0/support/CustomView.json +3478 -0
  493. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +464 -0
  494. package/source/openapi-specifications/v1.0/support/DBThrottle.json +334 -0
  495. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +1163 -0
  496. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +1258 -0
  497. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +2310 -0
  498. package/source/openapi-specifications/v1.0/support/Dashboards.json +1219 -0
  499. package/source/openapi-specifications/v1.0/support/DataChips.json +477 -0
  500. package/source/openapi-specifications/v1.0/support/DataImport.json +1099 -0
  501. package/source/openapi-specifications/v1.0/support/DataSync.json +1246 -0
  502. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +153 -0
  503. package/source/openapi-specifications/v1.0/support/Department.json +1971 -0
  504. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +656 -0
  505. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +232 -0
  506. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +722 -0
  507. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +91 -0
  508. package/source/openapi-specifications/v1.0/support/DomainMapping.json +1143 -0
  509. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +306 -0
  510. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +1491 -0
  511. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +572 -0
  512. package/source/openapi-specifications/v1.0/support/Event.json +3607 -0
  513. package/source/openapi-specifications/v1.0/support/EventComments.json +737 -0
  514. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +1520 -0
  515. package/source/openapi-specifications/v1.0/support/EventTimer.json +285 -0
  516. package/source/openapi-specifications/v1.0/support/Expression.json +43 -0
  517. package/source/openapi-specifications/v1.0/support/Extension.json +7152 -0
  518. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +129 -0
  519. package/source/openapi-specifications/v1.0/support/FAQ.json +142 -0
  520. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +178 -0
  521. package/source/openapi-specifications/v1.0/support/FbManager.json +1147 -0
  522. package/source/openapi-specifications/v1.0/support/Feature.json +691 -0
  523. package/source/openapi-specifications/v1.0/support/FeatureFile.json +435 -0
  524. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +576 -0
  525. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +492 -0
  526. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +318 -0
  527. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +198 -0
  528. package/source/openapi-specifications/v1.0/support/Field.json +7493 -0
  529. package/source/openapi-specifications/v1.0/support/FieldDetails.json +139 -0
  530. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +113 -0
  531. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +3831 -0
  532. package/source/openapi-specifications/v1.0/support/FileExport.json +324 -0
  533. package/source/openapi-specifications/v1.0/support/Finance.json +4290 -0
  534. package/source/openapi-specifications/v1.0/support/Followers.json +875 -0
  535. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +47 -0
  536. package/source/openapi-specifications/v1.0/support/GC_Bots.json +138 -0
  537. package/source/openapi-specifications/v1.0/support/GC_Guide.json +1536 -0
  538. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +58 -0
  539. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +79 -0
  540. package/source/openapi-specifications/v1.0/support/GC_Guides.json +89 -0
  541. package/source/openapi-specifications/v1.0/support/GC_Info.json +208 -0
  542. package/source/openapi-specifications/v1.0/support/GC_Status.json +69 -0
  543. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +79 -0
  544. package/source/openapi-specifications/v1.0/support/GenericAction.json +1888 -0
  545. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +1050 -0
  546. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +1715 -0
  547. package/source/openapi-specifications/v1.0/support/GoogleChat.json +650 -0
  548. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +44 -0
  549. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +900 -0
  550. package/source/openapi-specifications/v1.0/support/Helpcenter.json +1212 -0
  551. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +331 -0
  552. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +1496 -0
  553. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +504 -0
  554. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +208 -0
  555. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +64 -0
  556. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +211 -0
  557. package/source/openapi-specifications/v1.0/support/HolidayList.json +731 -0
  558. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +1091 -0
  559. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +1357 -0
  560. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +169 -0
  561. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +624 -0
  562. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +597 -0
  563. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +841 -0
  564. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +64 -0
  565. package/source/openapi-specifications/v1.0/support/IM_Bot.json +1007 -0
  566. package/source/openapi-specifications/v1.0/support/IM_BotService.json +357 -0
  567. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +323 -0
  568. package/source/openapi-specifications/v1.0/support/IM_Channel.json +2849 -0
  569. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +502 -0
  570. package/source/openapi-specifications/v1.0/support/IM_Contact.json +165 -0
  571. package/source/openapi-specifications/v1.0/support/IM_Efc.json +188 -0
  572. package/source/openapi-specifications/v1.0/support/IM_Integration.json +1269 -0
  573. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +454 -0
  574. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +625 -0
  575. package/source/openapi-specifications/v1.0/support/IM_License.json +225 -0
  576. package/source/openapi-specifications/v1.0/support/IM_Message.json +1371 -0
  577. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +462 -0
  578. package/source/openapi-specifications/v1.0/support/IM_Search.json +547 -0
  579. package/source/openapi-specifications/v1.0/support/IM_Session.json +1397 -0
  580. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +142 -0
  581. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +83 -0
  582. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +86 -0
  583. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +73 -0
  584. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +435 -0
  585. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +202 -0
  586. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +193 -0
  587. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +489 -0
  588. package/source/openapi-specifications/v1.0/support/Import.json +1844 -0
  589. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +395 -0
  590. package/source/openapi-specifications/v1.0/support/Inference.json +307 -0
  591. package/source/openapi-specifications/v1.0/support/InlineImage.json +97 -0
  592. package/source/openapi-specifications/v1.0/support/IntegModule.json +938 -0
  593. package/source/openapi-specifications/v1.0/support/Integrations.json +1264 -0
  594. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +539 -0
  595. package/source/openapi-specifications/v1.0/support/JWT.json +535 -0
  596. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +208 -0
  597. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +241 -0
  598. package/source/openapi-specifications/v1.0/support/KBPreference.json +323 -0
  599. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +2316 -0
  600. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +2839 -0
  601. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +570 -0
  602. package/source/openapi-specifications/v1.0/support/KBSection.json +1941 -0
  603. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +169 -0
  604. package/source/openapi-specifications/v1.0/support/KPIWidget.json +206 -0
  605. package/source/openapi-specifications/v1.0/support/KbBot.json +511 -0
  606. package/source/openapi-specifications/v1.0/support/KbCategory.json +1618 -0
  607. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +124 -0
  608. package/source/openapi-specifications/v1.0/support/Label.json +1251 -0
  609. package/source/openapi-specifications/v1.0/support/Layout.json +8042 -0
  610. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +491 -0
  611. package/source/openapi-specifications/v1.0/support/LayoutRules.json +1422 -0
  612. package/source/openapi-specifications/v1.0/support/LensInteg.json +86 -0
  613. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +548 -0
  614. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +1231 -0
  615. package/source/openapi-specifications/v1.0/support/LicenseTool.json +165 -0
  616. package/source/openapi-specifications/v1.0/support/Livecall.json +954 -0
  617. package/source/openapi-specifications/v1.0/support/LookupRecord.json +174 -0
  618. package/source/openapi-specifications/v1.0/support/Macros.json +1960 -0
  619. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +1263 -0
  620. package/source/openapi-specifications/v1.0/support/MassAction.json +1151 -0
  621. package/source/openapi-specifications/v1.0/support/MassActionError.json +55 -0
  622. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +89 -0
  623. package/source/openapi-specifications/v1.0/support/Mentions.json +491 -0
  624. package/source/openapi-specifications/v1.0/support/Message.json +685 -0
  625. package/source/openapi-specifications/v1.0/support/Microsoft.json +887 -0
  626. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +574 -0
  627. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +903 -0
  628. package/source/openapi-specifications/v1.0/support/Misc.json +214 -0
  629. package/source/openapi-specifications/v1.0/support/Module.json +1625 -0
  630. package/source/openapi-specifications/v1.0/support/NewCriteria.json +1863 -0
  631. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +204 -0
  632. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +150 -0
  633. package/source/openapi-specifications/v1.0/support/NotificationRules.json +441 -0
  634. package/source/openapi-specifications/v1.0/support/OEmbedData.json +233 -0
  635. package/source/openapi-specifications/v1.0/support/Onboarding.json +282 -0
  636. package/source/openapi-specifications/v1.0/support/Organization.json +1391 -0
  637. package/source/openapi-specifications/v1.0/support/PBGroup.json +634 -0
  638. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +433 -0
  639. package/source/openapi-specifications/v1.0/support/PBPlatform.json +1447 -0
  640. package/source/openapi-specifications/v1.0/support/PBX.json +550 -0
  641. package/source/openapi-specifications/v1.0/support/PBXConfig.json +219 -0
  642. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +443 -0
  643. package/source/openapi-specifications/v1.0/support/PBXPreference.json +314 -0
  644. package/source/openapi-specifications/v1.0/support/PageSense.json +1505 -0
  645. package/source/openapi-specifications/v1.0/support/PendingApproval.json +279 -0
  646. package/source/openapi-specifications/v1.0/support/Permalink.json +393 -0
  647. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +1014 -0
  648. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +118 -0
  649. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +1115 -0
  650. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +232 -0
  651. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +499 -0
  652. package/source/openapi-specifications/v1.0/support/Product.json +1861 -0
  653. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +485 -0
  654. package/source/openapi-specifications/v1.0/support/Profile.json +4236 -0
  655. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +989 -0
  656. package/source/openapi-specifications/v1.0/support/QueryStore.json +238 -0
  657. package/source/openapi-specifications/v1.0/support/QueueView.json +335 -0
  658. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +1204 -0
  659. package/source/openapi-specifications/v1.0/support/Records.json +1509 -0
  660. package/source/openapi-specifications/v1.0/support/Recyclebin.json +669 -0
  661. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +401 -0
  662. package/source/openapi-specifications/v1.0/support/Report.json +6491 -0
  663. package/source/openapi-specifications/v1.0/support/ReportChart.json +254 -0
  664. package/source/openapi-specifications/v1.0/support/ReportFolder.json +1076 -0
  665. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +202 -0
  666. package/source/openapi-specifications/v1.0/support/RequestFlags.json +358 -0
  667. package/source/openapi-specifications/v1.0/support/Resources.json +335 -0
  668. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +128 -0
  669. package/source/openapi-specifications/v1.0/support/Role.json +996 -0
  670. package/source/openapi-specifications/v1.0/support/RoundRobin.json +796 -0
  671. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +381 -0
  672. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +615 -0
  673. package/source/openapi-specifications/v1.0/support/RuleGroup.json +1630 -0
  674. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +227 -0
  675. package/source/openapi-specifications/v1.0/support/Saml.json +565 -0
  676. package/source/openapi-specifications/v1.0/support/Sandbox.json +1075 -0
  677. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +501 -0
  678. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +428 -0
  679. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +295 -0
  680. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +268 -0
  681. package/source/openapi-specifications/v1.0/support/SavedFilters.json +652 -0
  682. package/source/openapi-specifications/v1.0/support/Schedule.json +2077 -0
  683. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +2271 -0
  684. package/source/openapi-specifications/v1.0/support/Search.json +12600 -0
  685. package/source/openapi-specifications/v1.0/support/SearchInteg.json +2254 -0
  686. package/source/openapi-specifications/v1.0/support/Setup.json +1766 -0
  687. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +1110 -0
  688. package/source/openapi-specifications/v1.0/support/SharingRule.json +287 -0
  689. package/source/openapi-specifications/v1.0/support/Signature.json +354 -0
  690. package/source/openapi-specifications/v1.0/support/Skill.json +2164 -0
  691. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +269 -0
  692. package/source/openapi-specifications/v1.0/support/SkillType.json +807 -0
  693. package/source/openapi-specifications/v1.0/support/Slack.json +957 -0
  694. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +514 -0
  695. package/source/openapi-specifications/v1.0/support/Snippets.json +918 -0
  696. package/source/openapi-specifications/v1.0/support/SocialBrands.json +427 -0
  697. package/source/openapi-specifications/v1.0/support/SocialInteg.json +336 -0
  698. package/source/openapi-specifications/v1.0/support/SocialPosts.json +2460 -0
  699. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +337 -0
  700. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +690 -0
  701. package/source/openapi-specifications/v1.0/support/Statistics.json +125 -0
  702. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +2419 -0
  703. package/source/openapi-specifications/v1.0/support/Supervise.json +774 -0
  704. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +188 -0
  705. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +293 -0
  706. package/source/openapi-specifications/v1.0/support/SupportPlan.json +1109 -0
  707. package/source/openapi-specifications/v1.0/support/Tab.json +606 -0
  708. package/source/openapi-specifications/v1.0/support/Target.json +1311 -0
  709. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +130 -0
  710. package/source/openapi-specifications/v1.0/support/Task.json +4006 -0
  711. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +443 -0
  712. package/source/openapi-specifications/v1.0/support/TaskComments.json +706 -0
  713. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +1756 -0
  714. package/source/openapi-specifications/v1.0/support/TaskTimer.json +441 -0
  715. package/source/openapi-specifications/v1.0/support/Team.json +1383 -0
  716. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +1069 -0
  717. package/source/openapi-specifications/v1.0/support/Theme.json +152 -0
  718. package/source/openapi-specifications/v1.0/support/Thread.json +3545 -0
  719. package/source/openapi-specifications/v1.0/support/Ticket.json +9495 -0
  720. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +855 -0
  721. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +562 -0
  722. package/source/openapi-specifications/v1.0/support/TicketComment.json +1444 -0
  723. package/source/openapi-specifications/v1.0/support/TicketCount.json +690 -0
  724. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +454 -0
  725. package/source/openapi-specifications/v1.0/support/TicketHistory.json +414 -0
  726. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +369 -0
  727. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +178 -0
  728. package/source/openapi-specifications/v1.0/support/TicketTag.json +1513 -0
  729. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +907 -0
  730. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +1681 -0
  731. package/source/openapi-specifications/v1.0/support/TicketTimer.json +1205 -0
  732. package/source/openapi-specifications/v1.0/support/TimeTracking.json +1212 -0
  733. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +614 -0
  734. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +163 -0
  735. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +2772 -0
  736. package/source/openapi-specifications/v1.0/support/Upload.json +620 -0
  737. package/source/openapi-specifications/v1.0/support/User.json +1409 -0
  738. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +617 -0
  739. package/source/openapi-specifications/v1.0/support/UserPresence.json +763 -0
  740. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +107 -0
  741. package/source/openapi-specifications/v1.0/support/ValidationRules.json +1173 -0
  742. package/source/openapi-specifications/v1.0/support/Webhook.json +1330 -0
  743. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +132 -0
  744. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +143 -0
  745. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +132 -0
  746. package/source/openapi-specifications/v1.0/support/Widget.json +3023 -0
  747. package/source/openapi-specifications/v1.0/support/WmsDomain.json +104 -0
  748. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +756 -0
  749. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +989 -0
  750. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +135 -0
  751. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +376 -0
  752. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +159 -0
  753. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +3229 -0
  754. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +453 -0
  755. package/source/openapi-specifications/v1.0/support/Zwitch.json +1543 -0
  756. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +201 -0
  757. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +75 -0
  758. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +255 -0
  759. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +1677 -0
  760. package/source/openapi-specifications/v1.0/support/blueprintStates.json +284 -0
  761. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +91 -0
  762. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +1546 -0
  763. package/source/openapi-specifications/v1.0/support/blueprints.json +2992 -0
  764. package/source/openapi-specifications/v1.0/support/errors.json +80 -0
  765. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +416 -0
  766. package/.github/agents/Generators.agent.md +0 -121
@@ -0,0 +1,2310 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "DashboardMetrics",
5
+ "version" : "1.0.0",
6
+ "x-clan-group" : "reports",
7
+ "x-module-group" : "reports"
8
+ },
9
+ "paths" : {
10
+ "/api/v1/dashboards/customerHappinessMetrics" : {
11
+ "get" : {
12
+ "tags" : [ "DashboardMetrics" ],
13
+ "summary" : "CustomerHappiness",
14
+ "description" : "To get customer happiness count.",
15
+ "operationId" : "getCustomerHappinessMetrics",
16
+ "parameters" : [ {
17
+ "$ref" : "#/components/parameters/duration"
18
+ }, {
19
+ "$ref" : "#/components/parameters/agentId"
20
+ }, {
21
+ "$ref" : "#/components/parameters/departmentId"
22
+ }, {
23
+ "$ref" : "#/components/parameters/channel"
24
+ }, {
25
+ "name" : "sortBy",
26
+ "in" : "query",
27
+ "description" : "To get customer happiness based on user sorting option.This value can be @rating@ | @-rating@",
28
+ "required" : false,
29
+ "style" : "form",
30
+ "explode" : true,
31
+ "schema" : {
32
+ "type" : [ "string", "null" ],
33
+ "description" : "To get customer happiness based on user sorting option.This value can be @rating@ | @-rating@",
34
+ "enum" : [ "-rating", "rating" ],
35
+ "maxLength" : 100,
36
+ "minLength" : 0
37
+ }
38
+ }, {
39
+ "$ref" : "#/components/parameters/groupBy"
40
+ }, {
41
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
42
+ } ],
43
+ "responses" : {
44
+ "422" : {
45
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
46
+ },
47
+ "200" : {
48
+ "$ref" : "#/components/responses/customerHappinessMetrics"
49
+ }
50
+ },
51
+ "security" : [ {
52
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
53
+ }, {
54
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
55
+ } ],
56
+ "x-audience" : [ "company-internal" ],
57
+ "x-custom-url-attribute" : {
58
+ "security" : {
59
+ "throttle" : {
60
+ "inline" : [ {
61
+ "scope" : "APPSERVER",
62
+ "rules" : [ {
63
+ "duration" : 60000,
64
+ "lock-period" : 300000,
65
+ "threshold" : 30,
66
+ "hip" : false
67
+ } ],
68
+ "window" : "ROLLING",
69
+ "key" : "url.path+user.zuid"
70
+ } ]
71
+ },
72
+ "extraparams" : {
73
+ "disable" : true,
74
+ "ignore" : false
75
+ },
76
+ "authentication" : { }
77
+ },
78
+ "clan-group" : "reports",
79
+ "apihash" : "823aa6b1f608d84560cd55bf8767381b",
80
+ "module-group" : "reports",
81
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getCustomerHappinessRating"
82
+ }
83
+ }
84
+ },
85
+ "/api/v1/dashboards/onholdTickets" : {
86
+ "get" : {
87
+ "tags" : [ "DashboardMetrics" ],
88
+ "summary" : "Get on hold tickets count",
89
+ "description" : "This API fetches the number of tickets that are in the on hold status.",
90
+ "operationId" : "getOnholdTickets",
91
+ "parameters" : [ {
92
+ "$ref" : "#/components/parameters/duration"
93
+ }, {
94
+ "$ref" : "#/components/parameters/agentId"
95
+ }, {
96
+ "$ref" : "#/components/parameters/departmentId"
97
+ }, {
98
+ "name" : "sortOrder",
99
+ "in" : "query",
100
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
101
+ "required" : false,
102
+ "style" : "form",
103
+ "explode" : true,
104
+ "schema" : {
105
+ "type" : [ "boolean", "null" ],
106
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
107
+ "x-audience" : [ "company-internal" ]
108
+ }
109
+ }, {
110
+ "$ref" : "#/components/parameters/teamId"
111
+ }, {
112
+ "$ref" : "#/components/parameters/channel"
113
+ }, {
114
+ "$ref" : "#/components/parameters/groupBy"
115
+ }, {
116
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
117
+ } ],
118
+ "responses" : {
119
+ "422" : {
120
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
121
+ },
122
+ "200" : {
123
+ "$ref" : "#/components/responses/reopenedTickets"
124
+ }
125
+ },
126
+ "security" : [ {
127
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
128
+ }, {
129
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
130
+ } ],
131
+ "x-audience" : [ "external-public" ],
132
+ "x-custom-url-attribute" : {
133
+ "security" : {
134
+ "throttle" : {
135
+ "inline" : [ {
136
+ "scope" : "APPSERVER",
137
+ "rules" : [ {
138
+ "duration" : 60000,
139
+ "lock-period" : 600000,
140
+ "threshold" : 30,
141
+ "hip" : false
142
+ } ],
143
+ "window" : "ROLLING",
144
+ "key" : "url.path+user.zuid"
145
+ } ]
146
+ },
147
+ "extraparams" : {
148
+ "disable" : true,
149
+ "ignore" : false
150
+ },
151
+ "authentication" : { }
152
+ },
153
+ "clan-group" : "reports",
154
+ "apihash" : "83118c7c39978027366caec72eaff041",
155
+ "module-group" : "reports",
156
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getOnholdTickets"
157
+ }
158
+ }
159
+ },
160
+ "/api/v1/dashboards/solvedTickets" : {
161
+ "get" : {
162
+ "tags" : [ "DashboardMetrics" ],
163
+ "summary" : "Get closed tickets count",
164
+ "description" : "This API fetches the number of tickets that are resolved.",
165
+ "operationId" : "getSolvedTickets",
166
+ "parameters" : [ {
167
+ "$ref" : "#/components/parameters/duration"
168
+ }, {
169
+ "$ref" : "#/components/parameters/agentId"
170
+ }, {
171
+ "$ref" : "#/components/parameters/departmentId"
172
+ }, {
173
+ "name" : "sortOrder",
174
+ "in" : "query",
175
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
176
+ "required" : false,
177
+ "style" : "form",
178
+ "explode" : true,
179
+ "schema" : {
180
+ "type" : [ "boolean", "null" ],
181
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
182
+ "x-audience" : [ "company-internal" ]
183
+ }
184
+ }, {
185
+ "$ref" : "#/components/parameters/teamId"
186
+ }, {
187
+ "$ref" : "#/components/parameters/channel"
188
+ }, {
189
+ "$ref" : "#/components/parameters/groupBy"
190
+ }, {
191
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
192
+ } ],
193
+ "responses" : {
194
+ "422" : {
195
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
196
+ },
197
+ "200" : {
198
+ "$ref" : "#/components/responses/reopenedTickets"
199
+ }
200
+ },
201
+ "security" : [ {
202
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
203
+ }, {
204
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
205
+ } ],
206
+ "x-audience" : [ "external-public" ],
207
+ "x-custom-url-attribute" : {
208
+ "security" : {
209
+ "throttle" : {
210
+ "inline" : [ {
211
+ "scope" : "APPSERVER",
212
+ "rules" : [ {
213
+ "duration" : 60000,
214
+ "lock-period" : 600000,
215
+ "threshold" : 30,
216
+ "hip" : false
217
+ } ],
218
+ "window" : "ROLLING",
219
+ "key" : "url.path+user.zuid"
220
+ } ]
221
+ },
222
+ "extraparams" : {
223
+ "disable" : true,
224
+ "ignore" : false
225
+ },
226
+ "authentication" : { }
227
+ },
228
+ "clan-group" : "reports",
229
+ "apihash" : "f55e807bb9c8657ee5633e831af41a20",
230
+ "module-group" : "reports",
231
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getSolvedTickets"
232
+ }
233
+ }
234
+ },
235
+ "/api/v1/dashboards/ziaFieldValuePredictionMetrics" : {
236
+ "get" : {
237
+ "tags" : [ "DashboardMetrics" ],
238
+ "summary" : "Field Value Prediction Metrics",
239
+ "description" : "To get ZIA Field Value Prediction Metrics",
240
+ "operationId" : "getInferenceValueMetrics",
241
+ "parameters" : [ {
242
+ "$ref" : "#/components/parameters/duration"
243
+ }, {
244
+ "name" : "departmentId",
245
+ "in" : "query",
246
+ "description" : "ID(s) of the department(s) from which the stats must be fetched",
247
+ "required" : true,
248
+ "style" : "form",
249
+ "explode" : true,
250
+ "schema" : {
251
+ "type" : [ "string", "null", "integer" ],
252
+ "format" : "int64",
253
+ "description" : "ID(s) of the department(s) from which the stats must be fetched",
254
+ "pattern" : "([0-9]+)",
255
+ "x-custom-parameters-attributes" : {
256
+ "split" : ","
257
+ }
258
+ }
259
+ }, {
260
+ "$ref" : "#/components/parameters/predictionId"
261
+ }, {
262
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
263
+ } ],
264
+ "responses" : {
265
+ "422" : {
266
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
267
+ },
268
+ "200" : {
269
+ "$ref" : "#/components/responses/inferenceValueMetric"
270
+ }
271
+ },
272
+ "security" : [ {
273
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
274
+ }, {
275
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
276
+ } ],
277
+ "x-audience" : [ "company-internal" ],
278
+ "x-custom-url-attribute" : {
279
+ "security" : {
280
+ "throttle" : {
281
+ "inline" : [ {
282
+ "scope" : "APPSERVER",
283
+ "rules" : [ {
284
+ "duration" : 60000,
285
+ "lock-period" : 300000,
286
+ "threshold" : 30,
287
+ "hip" : false
288
+ } ],
289
+ "window" : "ROLLING",
290
+ "key" : "url.path+user.zuid"
291
+ } ]
292
+ },
293
+ "extraparams" : {
294
+ "disable" : true,
295
+ "ignore" : false
296
+ },
297
+ "authentication" : { }
298
+ },
299
+ "clan-group" : "zia",
300
+ "apihash" : "c3d11b233e434e0b0cc643d794bcff1b",
301
+ "module-group" : "zia",
302
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getZiaInferenceValueMetrics"
303
+ }
304
+ }
305
+ },
306
+ "/api/v1/dashboards/ticketByStatus" : {
307
+ "get" : {
308
+ "tags" : [ "DashboardMetrics" ],
309
+ "summary" : "TicketsByStatus",
310
+ "description" : "To get created tickets by status.",
311
+ "operationId" : "getTicketByStatus",
312
+ "parameters" : [ {
313
+ "$ref" : "#/components/parameters/duration"
314
+ }, {
315
+ "$ref" : "#/components/parameters/agentId"
316
+ }, {
317
+ "$ref" : "#/components/parameters/departmentId"
318
+ }, {
319
+ "$ref" : "#/components/parameters/sortOrder"
320
+ }, {
321
+ "$ref" : "#/components/parameters/teamId"
322
+ }, {
323
+ "$ref" : "#/components/parameters/channel"
324
+ }, {
325
+ "$ref" : "#/components/parameters/groupBy"
326
+ }, {
327
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
328
+ } ],
329
+ "responses" : {
330
+ "422" : {
331
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
332
+ },
333
+ "200" : {
334
+ "$ref" : "#/components/responses/ticketByStatus"
335
+ }
336
+ },
337
+ "security" : [ {
338
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
339
+ }, {
340
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
341
+ } ],
342
+ "x-audience" : [ "company-internal" ],
343
+ "x-custom-url-attribute" : {
344
+ "security" : {
345
+ "throttle" : {
346
+ "inline" : [ {
347
+ "scope" : "APPSERVER",
348
+ "rules" : [ {
349
+ "duration" : 60000,
350
+ "lock-period" : 300000,
351
+ "threshold" : 30,
352
+ "hip" : false
353
+ } ],
354
+ "window" : "ROLLING",
355
+ "key" : "url.path+user.zuid"
356
+ } ]
357
+ },
358
+ "extraparams" : {
359
+ "disable" : true,
360
+ "ignore" : false
361
+ },
362
+ "authentication" : { }
363
+ },
364
+ "clan-group" : "reports",
365
+ "apihash" : "7c6843e99364d9c72093798c9684d5f3",
366
+ "module-group" : "reports",
367
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getTicketByStatus"
368
+ }
369
+ }
370
+ },
371
+ "/api/v1/dashboards/backlogTickets" : {
372
+ "get" : {
373
+ "tags" : [ "DashboardMetrics" ],
374
+ "summary" : "Get unresolved tickets count",
375
+ "description" : "This API fetches the number of tickets that have remained unresolved over a particular period.",
376
+ "operationId" : "getBacklogTickets",
377
+ "parameters" : [ {
378
+ "$ref" : "#/components/parameters/duration"
379
+ }, {
380
+ "$ref" : "#/components/parameters/agentId"
381
+ }, {
382
+ "$ref" : "#/components/parameters/departmentId"
383
+ }, {
384
+ "$ref" : "#/components/parameters/channel"
385
+ }, {
386
+ "name" : "groupBy",
387
+ "in" : "query",
388
+ "description" : "Key that groups the ticket count according to a particular attribute.This value can be @date@ @channel@ @agent@",
389
+ "required" : true,
390
+ "style" : "form",
391
+ "explode" : true,
392
+ "schema" : {
393
+ "type" : [ "string", "null" ],
394
+ "description" : "Key that groups the ticket count according to a particular attribute.This value can be @date@ @channel@ @agent@",
395
+ "enum" : [ "date", "channel", "agent" ],
396
+ "maxLength" : 100,
397
+ "minLength" : 0
398
+ }
399
+ }, {
400
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
401
+ } ],
402
+ "responses" : {
403
+ "422" : {
404
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
405
+ },
406
+ "200" : {
407
+ "$ref" : "#/components/responses/reopenedTickets"
408
+ }
409
+ },
410
+ "security" : [ {
411
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
412
+ }, {
413
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
414
+ } ],
415
+ "x-audience" : [ "external-public" ],
416
+ "x-custom-url-attribute" : {
417
+ "security" : {
418
+ "throttle" : {
419
+ "inline" : [ {
420
+ "scope" : "APPSERVER",
421
+ "rules" : [ {
422
+ "duration" : 60000,
423
+ "lock-period" : 600000,
424
+ "threshold" : 30,
425
+ "hip" : false
426
+ } ],
427
+ "window" : "ROLLING",
428
+ "key" : "url.path+user.zuid"
429
+ } ]
430
+ },
431
+ "extraparams" : {
432
+ "disable" : true,
433
+ "ignore" : false
434
+ },
435
+ "authentication" : { }
436
+ },
437
+ "clan-group" : "reports",
438
+ "apihash" : "484c12a3178f978eda356e393b1d5fad",
439
+ "module-group" : "reports",
440
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getBacklogTickets"
441
+ }
442
+ }
443
+ },
444
+ "/api/v1/dashboards/reopenedTickets" : {
445
+ "get" : {
446
+ "tags" : [ "DashboardMetrics" ],
447
+ "summary" : "Get reopened tickets count",
448
+ "description" : "This API fetches the number of tickets that were reopened in your help desk portal.",
449
+ "operationId" : "getReopenedTickets",
450
+ "parameters" : [ {
451
+ "$ref" : "#/components/parameters/duration"
452
+ }, {
453
+ "$ref" : "#/components/parameters/agentId"
454
+ }, {
455
+ "$ref" : "#/components/parameters/departmentId"
456
+ }, {
457
+ "name" : "sortOrder",
458
+ "in" : "query",
459
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
460
+ "required" : false,
461
+ "style" : "form",
462
+ "explode" : true,
463
+ "schema" : {
464
+ "type" : [ "boolean", "null" ],
465
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
466
+ "x-audience" : [ "company-internal" ]
467
+ }
468
+ }, {
469
+ "$ref" : "#/components/parameters/teamId"
470
+ }, {
471
+ "$ref" : "#/components/parameters/channel"
472
+ }, {
473
+ "$ref" : "#/components/parameters/groupBy"
474
+ }, {
475
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
476
+ } ],
477
+ "responses" : {
478
+ "422" : {
479
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
480
+ },
481
+ "200" : {
482
+ "$ref" : "#/components/responses/reopenedTickets"
483
+ }
484
+ },
485
+ "security" : [ {
486
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
487
+ }, {
488
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
489
+ } ],
490
+ "x-audience" : [ "external-public" ],
491
+ "x-custom-url-attribute" : {
492
+ "security" : {
493
+ "throttle" : {
494
+ "inline" : [ {
495
+ "scope" : "APPSERVER",
496
+ "rules" : [ {
497
+ "duration" : 60000,
498
+ "lock-period" : 600000,
499
+ "threshold" : 30,
500
+ "hip" : false
501
+ } ],
502
+ "window" : "ROLLING",
503
+ "key" : "url.path+user.zuid"
504
+ } ]
505
+ },
506
+ "extraparams" : {
507
+ "disable" : true,
508
+ "ignore" : false
509
+ },
510
+ "authentication" : { }
511
+ },
512
+ "clan-group" : "reports",
513
+ "apihash" : "317ffe5cf428f3d9a9a7064ee9164239",
514
+ "module-group" : "reports",
515
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getReopenedTickets"
516
+ }
517
+ }
518
+ },
519
+ "/api/v1/dashboards/ziaPredictionMetrics" : {
520
+ "get" : {
521
+ "tags" : [ "DashboardMetrics" ],
522
+ "summary" : "Zia Prediction Metrics",
523
+ "description" : "To get ZIA Prediction Metrics",
524
+ "operationId" : "getZiaInferenceMetrics",
525
+ "parameters" : [ {
526
+ "$ref" : "#/components/parameters/duration"
527
+ }, {
528
+ "$ref" : "#/components/parameters/departmentId"
529
+ }, {
530
+ "$ref" : "#/components/parameters/groupBy"
531
+ }, {
532
+ "$ref" : "#/components/parameters/predictionId"
533
+ }, {
534
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
535
+ } ],
536
+ "responses" : {
537
+ "422" : {
538
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
539
+ },
540
+ "200" : {
541
+ "$ref" : "#/components/responses/inferenceMetrics"
542
+ }
543
+ },
544
+ "security" : [ {
545
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
546
+ }, {
547
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
548
+ } ],
549
+ "x-audience" : [ "company-internal" ],
550
+ "x-custom-url-attribute" : {
551
+ "security" : {
552
+ "throttle" : {
553
+ "inline" : [ {
554
+ "scope" : "APPSERVER",
555
+ "rules" : [ {
556
+ "duration" : 60000,
557
+ "lock-period" : 300000,
558
+ "threshold" : 30,
559
+ "hip" : false
560
+ } ],
561
+ "window" : "ROLLING",
562
+ "key" : "url.path+user.zuid"
563
+ } ]
564
+ },
565
+ "extraparams" : {
566
+ "disable" : true,
567
+ "ignore" : false
568
+ },
569
+ "authentication" : { }
570
+ },
571
+ "clan-group" : "zia",
572
+ "apihash" : "bf982e05cad88e9f003eb53b50230b11",
573
+ "module-group" : "zia",
574
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getZiaInferenceMetrics"
575
+ }
576
+ }
577
+ },
578
+ "/api/v1/dashboards/slaMetrics" : {
579
+ "get" : {
580
+ "tags" : [ "DashboardMetrics" ],
581
+ "summary" : "SLAMetrics",
582
+ "description" : "To get sla metrics like violationcount , successcount , breachtime, fullfilltime.Other params include - departmentId(list of department ids separated by commas.When departmentId is not given,data for all department is given),agentId(list of agent ids separated by commas.When agentId is not given,data for all agents is given),slaId(list of sla ids separated by commas.When slaId is not given,data for all sla is given),duration,startDate,endDate and channel.",
583
+ "operationId" : "getSlaMetrics",
584
+ "parameters" : [ {
585
+ "$ref" : "#/components/parameters/duration"
586
+ }, {
587
+ "$ref" : "#/components/parameters/agentId"
588
+ }, {
589
+ "$ref" : "#/components/parameters/slaId"
590
+ }, {
591
+ "$ref" : "#/components/parameters/violationType"
592
+ }, {
593
+ "$ref" : "#/components/parameters/departmentId"
594
+ }, {
595
+ "$ref" : "#/components/parameters/teamId"
596
+ }, {
597
+ "$ref" : "#/components/parameters/channel"
598
+ }, {
599
+ "$ref" : "#/components/parameters/groupBy"
600
+ }, {
601
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
602
+ } ],
603
+ "responses" : {
604
+ "422" : {
605
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
606
+ },
607
+ "200" : {
608
+ "$ref" : "#/components/responses/slaDashboard"
609
+ }
610
+ },
611
+ "security" : [ {
612
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
613
+ }, {
614
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
615
+ } ],
616
+ "x-audience" : [ "company-internal" ],
617
+ "x-custom-url-attribute" : {
618
+ "security" : {
619
+ "throttle" : {
620
+ "inline" : [ {
621
+ "scope" : "APPSERVER",
622
+ "rules" : [ {
623
+ "duration" : 60000,
624
+ "lock-period" : 300000,
625
+ "threshold" : 90,
626
+ "hip" : false
627
+ } ],
628
+ "window" : "ROLLING",
629
+ "key" : "url.path+user.zuid"
630
+ } ]
631
+ },
632
+ "extraparams" : {
633
+ "disable" : true,
634
+ "ignore" : false
635
+ },
636
+ "authentication" : { }
637
+ },
638
+ "clan-group" : "reports",
639
+ "apihash" : "32867705f083fcafd08fb369040f7081",
640
+ "module-group" : "reports",
641
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getSLAData"
642
+ }
643
+ }
644
+ },
645
+ "/api/v1/dashboards/ticketsResolutionTime" : {
646
+ "get" : {
647
+ "tags" : [ "DashboardMetrics" ],
648
+ "summary" : "List resolution times",
649
+ "description" : "This API lists the durations taken to resolve tickets.",
650
+ "operationId" : "getResolutionTime",
651
+ "parameters" : [ {
652
+ "$ref" : "#/components/parameters/duration"
653
+ }, {
654
+ "$ref" : "#/components/parameters/agentId"
655
+ }, {
656
+ "$ref" : "#/components/parameters/departmentId"
657
+ }, {
658
+ "name" : "sortOrder",
659
+ "in" : "query",
660
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
661
+ "required" : false,
662
+ "style" : "form",
663
+ "explode" : true,
664
+ "schema" : {
665
+ "type" : [ "boolean", "null" ],
666
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
667
+ "x-audience" : [ "company-internal" ]
668
+ }
669
+ }, {
670
+ "$ref" : "#/components/parameters/teamId"
671
+ }, {
672
+ "$ref" : "#/components/parameters/channel"
673
+ }, {
674
+ "$ref" : "#/components/parameters/groupBy"
675
+ }, {
676
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
677
+ } ],
678
+ "responses" : {
679
+ "422" : {
680
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
681
+ },
682
+ "200" : {
683
+ "$ref" : "#/components/responses/resolutionTime"
684
+ }
685
+ },
686
+ "security" : [ {
687
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
688
+ }, {
689
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
690
+ } ],
691
+ "x-audience" : [ "external-public" ],
692
+ "x-custom-url-attribute" : {
693
+ "security" : {
694
+ "throttle" : {
695
+ "inline" : [ {
696
+ "scope" : "APPSERVER",
697
+ "rules" : [ {
698
+ "duration" : 60000,
699
+ "lock-period" : 600000,
700
+ "threshold" : 30,
701
+ "hip" : false
702
+ } ],
703
+ "window" : "ROLLING",
704
+ "key" : "url.path+user.zuid"
705
+ } ]
706
+ },
707
+ "extraparams" : {
708
+ "disable" : true,
709
+ "ignore" : false
710
+ },
711
+ "authentication" : { }
712
+ },
713
+ "clan-group" : "reports",
714
+ "apihash" : "6cd5d76eea1e47d040a53ce530425274",
715
+ "module-group" : "reports",
716
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getResolutionTime"
717
+ }
718
+ }
719
+ },
720
+ "/api/v1/dashboards/createdTickets" : {
721
+ "get" : {
722
+ "tags" : [ "DashboardMetrics" ],
723
+ "summary" : "Get created tickets count",
724
+ "description" : "This API fetches the number of tickets created in a particular duration.",
725
+ "operationId" : "getCreatedTickets",
726
+ "parameters" : [ {
727
+ "$ref" : "#/components/parameters/duration"
728
+ }, {
729
+ "$ref" : "#/components/parameters/agentId"
730
+ }, {
731
+ "$ref" : "#/components/parameters/departmentId"
732
+ }, {
733
+ "name" : "sortOrder",
734
+ "in" : "query",
735
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
736
+ "required" : false,
737
+ "style" : "form",
738
+ "explode" : true,
739
+ "schema" : {
740
+ "type" : [ "boolean", "null" ],
741
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
742
+ "x-audience" : [ "company-internal" ]
743
+ }
744
+ }, {
745
+ "$ref" : "#/components/parameters/teamId"
746
+ }, {
747
+ "$ref" : "#/components/parameters/channel"
748
+ }, {
749
+ "$ref" : "#/components/parameters/groupBy"
750
+ }, {
751
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
752
+ } ],
753
+ "responses" : {
754
+ "422" : {
755
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
756
+ },
757
+ "200" : {
758
+ "$ref" : "#/components/responses/reopenedTickets"
759
+ }
760
+ },
761
+ "security" : [ {
762
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
763
+ }, {
764
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
765
+ } ],
766
+ "x-audience" : [ "external-public" ],
767
+ "x-custom-url-attribute" : {
768
+ "security" : {
769
+ "throttle" : {
770
+ "inline" : [ {
771
+ "scope" : "APPSERVER",
772
+ "rules" : [ {
773
+ "duration" : 60000,
774
+ "lock-period" : 600000,
775
+ "threshold" : 30,
776
+ "hip" : false
777
+ } ],
778
+ "window" : "ROLLING",
779
+ "key" : "url.path+user.zuid"
780
+ } ]
781
+ },
782
+ "extraparams" : {
783
+ "disable" : true,
784
+ "ignore" : false
785
+ },
786
+ "authentication" : { }
787
+ },
788
+ "clan-group" : "reports",
789
+ "apihash" : "56a8d5f379f87df4de7b897ec2e4108c",
790
+ "module-group" : "reports",
791
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getCreatedTickets"
792
+ }
793
+ }
794
+ },
795
+ "/api/v1/dashboards/slaOverViewMetrics" : {
796
+ "get" : {
797
+ "tags" : [ "DashboardMetrics" ],
798
+ "summary" : "SLAOverViewMetrics",
799
+ "description" : "To get sla Overview metrics like violationcount , successcount , breachtime, fullfilltime.Other params include - departmentId(list of department ids separated by commas.When departmentId is not given,data for all department is given),agentId(list of agent ids separated by commas.When agentId is not given,data for all agents is given),slaId(list of sla ids separated by commas.When slaId is not given,data for all sla is given),duration,startDate,endDate and channel.",
800
+ "operationId" : "getSlaOverViewMetrics",
801
+ "parameters" : [ {
802
+ "$ref" : "#/components/parameters/duration"
803
+ }, {
804
+ "$ref" : "#/components/parameters/agentId"
805
+ }, {
806
+ "$ref" : "#/components/parameters/slaId"
807
+ }, {
808
+ "$ref" : "#/components/parameters/violationType"
809
+ }, {
810
+ "$ref" : "#/components/parameters/departmentId"
811
+ }, {
812
+ "$ref" : "#/components/parameters/teamId"
813
+ }, {
814
+ "$ref" : "#/components/parameters/channel"
815
+ }, {
816
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
817
+ } ],
818
+ "responses" : {
819
+ "422" : {
820
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
821
+ },
822
+ "200" : {
823
+ "$ref" : "#/components/responses/slaOverViewMetrics"
824
+ }
825
+ },
826
+ "security" : [ {
827
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
828
+ }, {
829
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
830
+ } ],
831
+ "x-audience" : [ "company-internal" ],
832
+ "x-custom-url-attribute" : {
833
+ "security" : {
834
+ "throttle" : {
835
+ "inline" : [ {
836
+ "scope" : "APPSERVER",
837
+ "rules" : [ {
838
+ "duration" : 60000,
839
+ "lock-period" : 300000,
840
+ "threshold" : 60,
841
+ "hip" : false
842
+ } ],
843
+ "window" : "ROLLING",
844
+ "key" : "url.path+user.zuid"
845
+ } ]
846
+ },
847
+ "extraparams" : {
848
+ "disable" : true,
849
+ "ignore" : false
850
+ },
851
+ "authentication" : { }
852
+ },
853
+ "clan-group" : "reports",
854
+ "apihash" : "ea19e76cd66ed9f52a6f4081034fa644",
855
+ "module-group" : "reports",
856
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getSLAOverViewData"
857
+ }
858
+ }
859
+ },
860
+ "/api/v1/dashboards/responseCount" : {
861
+ "get" : {
862
+ "tags" : [ "DashboardMetrics" ],
863
+ "summary" : "Get total response count",
864
+ "description" : "This API fetches the total number of responses sent/made by your agents.",
865
+ "operationId" : "getResponseCount",
866
+ "parameters" : [ {
867
+ "$ref" : "#/components/parameters/duration"
868
+ }, {
869
+ "$ref" : "#/components/parameters/agentId"
870
+ }, {
871
+ "$ref" : "#/components/parameters/departmentId"
872
+ }, {
873
+ "name" : "sortOrder",
874
+ "in" : "query",
875
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
876
+ "required" : false,
877
+ "style" : "form",
878
+ "explode" : true,
879
+ "schema" : {
880
+ "type" : [ "boolean", "null" ],
881
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
882
+ "x-audience" : [ "company-internal" ]
883
+ }
884
+ }, {
885
+ "$ref" : "#/components/parameters/teamId"
886
+ }, {
887
+ "$ref" : "#/components/parameters/channel"
888
+ }, {
889
+ "$ref" : "#/components/parameters/groupBy"
890
+ }, {
891
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
892
+ } ],
893
+ "responses" : {
894
+ "422" : {
895
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
896
+ },
897
+ "200" : {
898
+ "$ref" : "#/components/responses/responseCount"
899
+ }
900
+ },
901
+ "security" : [ {
902
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
903
+ }, {
904
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
905
+ } ],
906
+ "x-audience" : [ "external-public" ],
907
+ "x-custom-url-attribute" : {
908
+ "security" : {
909
+ "throttle" : {
910
+ "policy" : "ReadAPI_Stringent_UserPolicy,SubConcurrency_Stringent_OrgPolicy"
911
+ },
912
+ "extraparams" : {
913
+ "disable" : true,
914
+ "ignore" : false
915
+ },
916
+ "authentication" : { }
917
+ },
918
+ "clan-group" : "reports",
919
+ "apihash" : "34092ad84c96c8e6120c23d2b26d13dd",
920
+ "module-group" : "reports",
921
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getResponseCount"
922
+ }
923
+ }
924
+ },
925
+ "/api/v1/dashboards/responseTime" : {
926
+ "get" : {
927
+ "tags" : [ "DashboardMetrics" ],
928
+ "summary" : "List response times",
929
+ "description" : "This API lists the durations taken to respond to tickets.",
930
+ "operationId" : "getResponseTime",
931
+ "parameters" : [ {
932
+ "$ref" : "#/components/parameters/duration"
933
+ }, {
934
+ "$ref" : "#/components/parameters/agentId"
935
+ }, {
936
+ "$ref" : "#/components/parameters/departmentId"
937
+ }, {
938
+ "$ref" : "#/components/parameters/teamId"
939
+ }, {
940
+ "$ref" : "#/components/parameters/channel"
941
+ }, {
942
+ "$ref" : "#/components/parameters/groupBy"
943
+ }, {
944
+ "name" : "isFirstResponse",
945
+ "in" : "query",
946
+ "description" : "Key that specifies if the response is the first response to the customer question",
947
+ "required" : true,
948
+ "style" : "form",
949
+ "explode" : true,
950
+ "schema" : {
951
+ "type" : [ "boolean", "null" ],
952
+ "description" : "Key that specifies if the response is the first response to the customer question"
953
+ }
954
+ }, {
955
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
956
+ } ],
957
+ "responses" : {
958
+ "422" : {
959
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
960
+ },
961
+ "200" : {
962
+ "$ref" : "#/components/responses/responseTime"
963
+ }
964
+ },
965
+ "security" : [ {
966
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
967
+ }, {
968
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
969
+ } ],
970
+ "x-audience" : [ "external-public" ],
971
+ "x-custom-url-attribute" : {
972
+ "security" : {
973
+ "throttle" : {
974
+ "policy" : "ReadAPI_Stringent_UserPolicy,SubConcurrency_Stringent_OrgPolicy"
975
+ },
976
+ "extraparams" : {
977
+ "disable" : true,
978
+ "ignore" : false
979
+ },
980
+ "authentication" : { }
981
+ },
982
+ "clan-group" : "reports",
983
+ "apihash" : "19fad44b77185af92813740760d46460",
984
+ "module-group" : "reports",
985
+ "apimethod" : "com.zoho.support.restapi.DashboardService.getResponseTimeData"
986
+ }
987
+ }
988
+ }
989
+ },
990
+ "components" : {
991
+ "schemas" : {
992
+ "happinessMetricsObject" : {
993
+ "type" : [ "object", "null" ],
994
+ "additionalProperties" : false,
995
+ "properties" : {
996
+ "badCount" : {
997
+ "type" : [ "string", "null", "integer" ],
998
+ "format" : "int64",
999
+ "pattern" : "([0-9]+)"
1000
+ },
1001
+ "goodCount" : {
1002
+ "type" : [ "string", "null", "integer" ],
1003
+ "format" : "int64",
1004
+ "pattern" : "([0-9]+)"
1005
+ },
1006
+ "value" : {
1007
+ "type" : [ "string", "null" ],
1008
+ "maxLength" : 100,
1009
+ "minLength" : 0,
1010
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1011
+ },
1012
+ "okCount" : {
1013
+ "type" : [ "string", "null", "integer" ],
1014
+ "format" : "int64",
1015
+ "pattern" : "([0-9]+)"
1016
+ },
1017
+ "referenceValue" : {
1018
+ "type" : [ "string", "null" ],
1019
+ "maxLength" : 100,
1020
+ "minLength" : 0,
1021
+ "pattern" : "(null|^$|NULL|[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+)"
1022
+ }
1023
+ },
1024
+ "required" : [ "badCount", "goodCount", "okCount", "referenceValue", "value" ]
1025
+ },
1026
+ "happinessMetricsArray" : {
1027
+ "type" : [ "array", "null" ],
1028
+ "items" : {
1029
+ "$ref" : "./DashboardMetrics.json#/components/schemas/happinessMetricsObject"
1030
+ }
1031
+ },
1032
+ "countArrayObject" : {
1033
+ "type" : [ "object", "null" ],
1034
+ "additionalProperties" : false,
1035
+ "properties" : {
1036
+ "count" : {
1037
+ "type" : [ "string", "null", "integer" ],
1038
+ "format" : "int64",
1039
+ "pattern" : "([0-9]+)"
1040
+ },
1041
+ "value" : {
1042
+ "type" : [ "string", "null" ],
1043
+ "maxLength" : 100,
1044
+ "minLength" : 0,
1045
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1046
+ },
1047
+ "referenceValue" : {
1048
+ "type" : [ "string", "null", "integer" ],
1049
+ "format" : "int64",
1050
+ "pattern" : "([0-9]+)"
1051
+ }
1052
+ },
1053
+ "required" : [ "count", "referenceValue", "value" ]
1054
+ },
1055
+ "countArray" : {
1056
+ "type" : [ "array", "null" ],
1057
+ "items" : {
1058
+ "$ref" : "./DashboardMetrics.json#/components/schemas/countArrayObject"
1059
+ }
1060
+ },
1061
+ "ziaInferenceValueMetricObject" : {
1062
+ "type" : [ "object", "null" ],
1063
+ "additionalProperties" : false,
1064
+ "properties" : {
1065
+ "totalFieldValuePredictionOccurences" : {
1066
+ "type" : [ "string", "null", "integer" ],
1067
+ "format" : "int64",
1068
+ "pattern" : "([0-9]+)"
1069
+ },
1070
+ "predictedFieldValue" : {
1071
+ "type" : [ "string", "null" ],
1072
+ "maxLength" : 100,
1073
+ "minLength" : 0,
1074
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1075
+ },
1076
+ "referenceValue" : {
1077
+ "type" : [ "string", "null" ],
1078
+ "maxLength" : 100,
1079
+ "minLength" : 0,
1080
+ "pattern" : "(null|^$|NULL|[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+)"
1081
+ }
1082
+ },
1083
+ "required" : [ "predictedFieldValue", "referenceValue", "totalFieldValuePredictionOccurences" ]
1084
+ },
1085
+ "ziaInferenceValueMetricValueArray" : {
1086
+ "type" : [ "array", "null" ],
1087
+ "items" : {
1088
+ "$ref" : "./DashboardMetrics.json#/components/schemas/ziaInferenceValueMetricObject"
1089
+ }
1090
+ },
1091
+ "statusInfoObject" : {
1092
+ "type" : [ "object", "null" ],
1093
+ "additionalProperties" : false,
1094
+ "properties" : {
1095
+ "statusMapping" : {
1096
+ "type" : [ "string", "null" ],
1097
+ "enum" : [ "Open", "Closed", "On Hold" ],
1098
+ "maxLength" : 100,
1099
+ "minLength" : 0
1100
+ },
1101
+ "count" : {
1102
+ "type" : [ "string", "null", "integer" ],
1103
+ "format" : "int64",
1104
+ "pattern" : "([0-9]+)"
1105
+ },
1106
+ "status" : {
1107
+ "type" : [ "string", "null" ],
1108
+ "x-dynamic-enum" : true
1109
+ }
1110
+ },
1111
+ "required" : [ "count", "status", "statusMapping" ]
1112
+ },
1113
+ "statusInfoArray" : {
1114
+ "type" : [ "array", "null" ],
1115
+ "items" : {
1116
+ "$ref" : "./DashboardMetrics.json#/components/schemas/statusInfoObject"
1117
+ }
1118
+ },
1119
+ "ticketCountObject" : {
1120
+ "type" : [ "object", "null" ],
1121
+ "additionalProperties" : false,
1122
+ "properties" : {
1123
+ "statusInfo" : {
1124
+ "$ref" : "./DashboardMetrics.json#/components/schemas/statusInfoArray"
1125
+ },
1126
+ "value" : {
1127
+ "type" : [ "string", "null" ],
1128
+ "maxLength" : 100,
1129
+ "minLength" : 0,
1130
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1131
+ }
1132
+ },
1133
+ "required" : [ "statusInfo", "value" ]
1134
+ },
1135
+ "ticketCountArray" : {
1136
+ "type" : [ "array", "null" ],
1137
+ "items" : {
1138
+ "$ref" : "./DashboardMetrics.json#/components/schemas/ticketCountObject"
1139
+ }
1140
+ },
1141
+ "ziaInferenceMetricsObject" : {
1142
+ "type" : [ "object", "null" ],
1143
+ "additionalProperties" : false,
1144
+ "properties" : {
1145
+ "overriddenPredictionsCount" : {
1146
+ "type" : [ "string", "null", "integer" ],
1147
+ "format" : "int64",
1148
+ "pattern" : "([0-9]+)"
1149
+ },
1150
+ "missedPredictionsCount" : {
1151
+ "type" : [ "string", "null", "integer" ],
1152
+ "format" : "int64",
1153
+ "pattern" : "([0-9]+)"
1154
+ },
1155
+ "predictionsCount" : {
1156
+ "type" : [ "string", "null", "integer" ],
1157
+ "format" : "int64",
1158
+ "pattern" : "([0-9]+)"
1159
+ },
1160
+ "value" : {
1161
+ "type" : [ "string", "null" ],
1162
+ "maxLength" : 100,
1163
+ "minLength" : 0,
1164
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1165
+ },
1166
+ "incomingResponsesCount" : {
1167
+ "type" : [ "string", "null", "integer" ],
1168
+ "format" : "int64",
1169
+ "pattern" : "([0-9]+)"
1170
+ },
1171
+ "referenceValue" : {
1172
+ "type" : [ "string", "null" ],
1173
+ "maxLength" : 100,
1174
+ "minLength" : 0,
1175
+ "pattern" : "(null|^$|NULL|[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+)"
1176
+ }
1177
+ },
1178
+ "required" : [ "incomingResponsesCount", "missedPredictionsCount", "overriddenPredictionsCount", "predictionsCount", "referenceValue", "value" ]
1179
+ },
1180
+ "ziaInferenceMetricsArray" : {
1181
+ "type" : [ "array", "null" ],
1182
+ "items" : {
1183
+ "$ref" : "./DashboardMetrics.json#/components/schemas/ziaInferenceMetricsObject"
1184
+ }
1185
+ },
1186
+ "slaDashboardObject" : {
1187
+ "type" : [ "object", "null" ],
1188
+ "additionalProperties" : false,
1189
+ "properties" : {
1190
+ "agentId" : {
1191
+ "type" : [ "string", "null", "integer" ],
1192
+ "format" : "int64",
1193
+ "pattern" : "([0-9]+)"
1194
+ },
1195
+ "violationCount" : {
1196
+ "type" : [ "string", "null", "integer" ],
1197
+ "format" : "int64",
1198
+ "pattern" : "([0-9]+)"
1199
+ },
1200
+ "violatedTicketsCount" : {
1201
+ "type" : [ "string", "null", "integer" ],
1202
+ "format" : "int64",
1203
+ "pattern" : "([0-9]+)"
1204
+ },
1205
+ "breachTime" : {
1206
+ "type" : [ "string", "null", "integer" ],
1207
+ "format" : "int64",
1208
+ "pattern" : "([0-9]+)"
1209
+ },
1210
+ "fulfillTime" : {
1211
+ "type" : [ "string", "null", "integer" ],
1212
+ "format" : "int64",
1213
+ "pattern" : "([0-9]+)"
1214
+ },
1215
+ "successCount" : {
1216
+ "type" : [ "string", "null", "integer" ],
1217
+ "format" : "int64",
1218
+ "pattern" : "([0-9]+)"
1219
+ },
1220
+ "succeededTicketCount" : {
1221
+ "type" : [ "string", "null", "integer" ],
1222
+ "format" : "int64",
1223
+ "pattern" : "([0-9]+)"
1224
+ },
1225
+ "value" : {
1226
+ "type" : [ "string", "null" ],
1227
+ "maxLength" : 100,
1228
+ "minLength" : 0,
1229
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1230
+ },
1231
+ "referenceValue" : {
1232
+ "type" : [ "string", "null", "integer" ],
1233
+ "format" : "int64",
1234
+ "pattern" : "([0-9]+)"
1235
+ }
1236
+ },
1237
+ "required" : [ "agentId", "breachTime", "fulfillTime", "referenceValue", "succeededTicketCount", "successCount", "value", "violatedTicketsCount", "violationCount" ]
1238
+ },
1239
+ "slaMetricsData" : {
1240
+ "type" : [ "array", "null" ],
1241
+ "items" : {
1242
+ "$ref" : "./DashboardMetrics.json#/components/schemas/slaDashboardObject"
1243
+ }
1244
+ },
1245
+ "resolutionTimeObject" : {
1246
+ "type" : [ "object", "null" ],
1247
+ "additionalProperties" : false,
1248
+ "properties" : {
1249
+ "avgSystemTime" : {
1250
+ "type" : [ "string", "null" ],
1251
+ "maxLength" : 100,
1252
+ "minLength" : 0,
1253
+ "pattern" : "((^([0-9]*):([0-5][0-9]) hrs$)|null|undefined)"
1254
+ },
1255
+ "ticketCount" : {
1256
+ "type" : [ "string", "null", "integer" ],
1257
+ "format" : "int64",
1258
+ "pattern" : "([0-9]+)"
1259
+ },
1260
+ "avgAgentTime" : {
1261
+ "type" : [ "string", "null" ],
1262
+ "maxLength" : 100,
1263
+ "minLength" : 0,
1264
+ "pattern" : "((^([0-9]*):([0-5][0-9]) hrs$)|null|undefined)"
1265
+ },
1266
+ "value" : {
1267
+ "type" : [ "string", "null" ],
1268
+ "maxLength" : 100,
1269
+ "minLength" : 0,
1270
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1271
+ },
1272
+ "referenceValue" : {
1273
+ "type" : [ "string", "null", "integer" ],
1274
+ "format" : "int64",
1275
+ "pattern" : "([0-9]+)"
1276
+ }
1277
+ },
1278
+ "required" : [ "avgAgentTime", "avgSystemTime", "referenceValue", "ticketCount", "value" ]
1279
+ },
1280
+ "resolutionTimeArray" : {
1281
+ "type" : [ "array", "null" ],
1282
+ "items" : {
1283
+ "$ref" : "./DashboardMetrics.json#/components/schemas/resolutionTimeObject"
1284
+ }
1285
+ },
1286
+ "responseTimeObject" : {
1287
+ "type" : [ "object", "null" ],
1288
+ "additionalProperties" : false,
1289
+ "properties" : {
1290
+ "avgSystemTime" : {
1291
+ "type" : [ "string", "null" ],
1292
+ "maxLength" : 100,
1293
+ "minLength" : 0,
1294
+ "pattern" : "((^([0-9]*):([0-5][0-9]) hrs$)|null|undefined)"
1295
+ },
1296
+ "avgAgentTime" : {
1297
+ "type" : [ "string", "null" ],
1298
+ "maxLength" : 100,
1299
+ "minLength" : 0,
1300
+ "pattern" : "((^([0-9]*):([0-5][0-9]) hrs$)|null|undefined)"
1301
+ },
1302
+ "responseCount" : {
1303
+ "type" : [ "string", "null", "integer" ],
1304
+ "format" : "int64",
1305
+ "pattern" : "([0-9]+)"
1306
+ },
1307
+ "value" : {
1308
+ "type" : [ "string", "null" ],
1309
+ "maxLength" : 100,
1310
+ "minLength" : 0,
1311
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1312
+ },
1313
+ "referenceValue" : {
1314
+ "type" : [ "string", "null", "integer" ],
1315
+ "format" : "int64",
1316
+ "pattern" : "([0-9]+)"
1317
+ }
1318
+ },
1319
+ "required" : [ "avgAgentTime", "avgSystemTime", "referenceValue", "responseCount", "value" ]
1320
+ },
1321
+ "responseTimeArray" : {
1322
+ "type" : [ "array", "null" ],
1323
+ "items" : {
1324
+ "$ref" : "./DashboardMetrics.json#/components/schemas/responseTimeObject"
1325
+ }
1326
+ }
1327
+ },
1328
+ "responses" : {
1329
+ "customerHappinessMetrics" : {
1330
+ "description" : "customerHappinessMetrics template definitions",
1331
+ "content" : {
1332
+ "application/json" : {
1333
+ "schema" : {
1334
+ "type" : [ "object", "null" ],
1335
+ "additionalProperties" : false,
1336
+ "properties" : {
1337
+ "totalBadCount" : {
1338
+ "type" : [ "string", "null", "integer" ],
1339
+ "format" : "int64",
1340
+ "pattern" : "([0-9]+)"
1341
+ },
1342
+ "totalGoodCount" : {
1343
+ "type" : [ "string", "null", "integer" ],
1344
+ "format" : "int64",
1345
+ "pattern" : "([0-9]+)"
1346
+ },
1347
+ "groupedBy" : {
1348
+ "type" : [ "string", "null" ],
1349
+ "enum" : [ "date", "channel", "agent", "hour" ],
1350
+ "maxLength" : 100,
1351
+ "minLength" : 0,
1352
+ "x-custom-parameters-attributes" : {
1353
+ "removeExif" : false,
1354
+ "filterMatchedContent" : false,
1355
+ "antivirus" : false,
1356
+ "replacementString" : "",
1357
+ "allowInvalid" : false,
1358
+ "descrption" : "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@",
1359
+ "secret" : false,
1360
+ "preserveCharsLimit" : 10,
1361
+ "trim" : false,
1362
+ "internalParam" : false,
1363
+ "preserveChars" : "0,5",
1364
+ "importUrl" : false,
1365
+ "decrypt" : false
1366
+ }
1367
+ },
1368
+ "totalOkCount" : {
1369
+ "type" : [ "string", "null", "integer" ],
1370
+ "format" : "int64",
1371
+ "pattern" : "([0-9]+)"
1372
+ },
1373
+ "happinessMetrics" : {
1374
+ "$ref" : "./DashboardMetrics.json#/components/schemas/happinessMetricsArray"
1375
+ }
1376
+ },
1377
+ "required" : [ "groupedBy", "happinessMetrics", "totalBadCount", "totalGoodCount", "totalOkCount" ]
1378
+ },
1379
+ "examples" : {
1380
+ "Valid responses Definitions" : {
1381
+ "value" : {
1382
+ "totalBadCount" : "20",
1383
+ "totalGoodCount" : "20",
1384
+ "groupedBy" : "agent",
1385
+ "totalOkCount" : "20",
1386
+ "happinessMetrics" : [ {
1387
+ "badCount" : "12",
1388
+ "goodCount" : "12",
1389
+ "value" : "Jhon",
1390
+ "okCount" : "12",
1391
+ "referenceValue" : "123123213"
1392
+ } ]
1393
+ }
1394
+ }
1395
+ }
1396
+ }
1397
+ },
1398
+ "x-custom-response-attributes" : {
1399
+ "disable-safe-headers" : "[]"
1400
+ }
1401
+ },
1402
+ "reopenedTickets" : {
1403
+ "description" : "reopenedTickets template definitions",
1404
+ "content" : {
1405
+ "application/json" : {
1406
+ "schema" : {
1407
+ "type" : [ "object", "null" ],
1408
+ "additionalProperties" : false,
1409
+ "properties" : {
1410
+ "totalTicketCount" : {
1411
+ "type" : [ "string", "null", "integer" ],
1412
+ "format" : "int64",
1413
+ "pattern" : "([0-9]+)"
1414
+ },
1415
+ "avg" : {
1416
+ "type" : [ "string", "null" ],
1417
+ "maxLength" : 100,
1418
+ "minLength" : 0,
1419
+ "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
1420
+ },
1421
+ "ticketCount" : {
1422
+ "$ref" : "./DashboardMetrics.json#/components/schemas/countArray"
1423
+ },
1424
+ "groupedBy" : {
1425
+ "type" : [ "string", "null" ],
1426
+ "enum" : [ "date", "channel", "agent", "hour" ],
1427
+ "maxLength" : 100,
1428
+ "minLength" : 0,
1429
+ "x-custom-parameters-attributes" : {
1430
+ "removeExif" : false,
1431
+ "filterMatchedContent" : false,
1432
+ "antivirus" : false,
1433
+ "replacementString" : "",
1434
+ "allowInvalid" : false,
1435
+ "descrption" : "Key that groups the ticket count according to a particular attribute.This value can be @date@ @channel@ @agent@ | @hour@",
1436
+ "secret" : false,
1437
+ "preserveCharsLimit" : 10,
1438
+ "trim" : false,
1439
+ "internalParam" : false,
1440
+ "preserveChars" : "0,5",
1441
+ "importUrl" : false,
1442
+ "decrypt" : false
1443
+ }
1444
+ }
1445
+ },
1446
+ "required" : [ "avg", "groupedBy", "ticketCount", "totalTicketCount" ]
1447
+ },
1448
+ "examples" : {
1449
+ "Valid responses Definitions" : {
1450
+ "value" : {
1451
+ "totalTicketCount" : "1",
1452
+ "avg" : "0.1",
1453
+ "ticketCount" : [ {
1454
+ "count" : "0",
1455
+ "value" : "2018-04-01",
1456
+ "referenceValue" : null
1457
+ }, {
1458
+ "count" : "0",
1459
+ "value" : "2018-04-02",
1460
+ "referenceValue" : null
1461
+ }, {
1462
+ "count" : "0",
1463
+ "value" : "2018-04-03",
1464
+ "referenceValue" : null
1465
+ }, {
1466
+ "count" : "0",
1467
+ "value" : "2018-04-04",
1468
+ "referenceValue" : null
1469
+ }, {
1470
+ "count" : "0",
1471
+ "value" : "2018-04-05",
1472
+ "referenceValue" : null
1473
+ }, {
1474
+ "count" : "1",
1475
+ "value" : "2018-04-06",
1476
+ "referenceValue" : null
1477
+ }, {
1478
+ "count" : "0",
1479
+ "value" : "2018-04-07",
1480
+ "referenceValue" : null
1481
+ } ],
1482
+ "groupedBy" : "date"
1483
+ }
1484
+ }
1485
+ }
1486
+ }
1487
+ },
1488
+ "x-custom-response-attributes" : {
1489
+ "disable-safe-headers" : "[]"
1490
+ }
1491
+ },
1492
+ "inferenceValueMetric" : {
1493
+ "description" : "inferenceValueMetric template definitions",
1494
+ "content" : {
1495
+ "application/json" : {
1496
+ "schema" : {
1497
+ "type" : [ "object", "null" ],
1498
+ "additionalProperties" : false,
1499
+ "properties" : {
1500
+ "fieldValuePredictionMetrics" : {
1501
+ "$ref" : "./DashboardMetrics.json#/components/schemas/ziaInferenceValueMetricValueArray"
1502
+ },
1503
+ "groupedBy" : {
1504
+ "type" : [ "string", "null" ],
1505
+ "maxLength" : 100,
1506
+ "minLength" : 0,
1507
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1508
+ },
1509
+ "totalPredictionOccurrences" : {
1510
+ "type" : [ "string", "null", "integer" ],
1511
+ "format" : "int64",
1512
+ "pattern" : "([0-9]+)"
1513
+ }
1514
+ },
1515
+ "required" : [ "fieldValuePredictionMetrics", "groupedBy", "totalPredictionOccurrences" ]
1516
+ },
1517
+ "examples" : {
1518
+ "Valid responses Definitions" : {
1519
+ "value" : {
1520
+ "fieldValuePredictionMetrics" : [ {
1521
+ "predictedValue" : "High",
1522
+ "predictionOccurences" : "2",
1523
+ "referenceValue" : null
1524
+ }, {
1525
+ "predictedValue" : "Low",
1526
+ "predictionOccurences" : "0",
1527
+ "referenceValue" : null
1528
+ }, {
1529
+ "predictedValue" : "Medium",
1530
+ "predictionOccurences" : "1",
1531
+ "referenceValue" : null
1532
+ } ],
1533
+ "totalPredictionOccurrences" : "3"
1534
+ }
1535
+ }
1536
+ }
1537
+ }
1538
+ },
1539
+ "x-custom-response-attributes" : {
1540
+ "disable-safe-headers" : "[]"
1541
+ }
1542
+ },
1543
+ "ticketByStatus" : {
1544
+ "description" : "ticketByStatus template definitions",
1545
+ "content" : {
1546
+ "application/json" : {
1547
+ "schema" : {
1548
+ "type" : [ "object", "null" ],
1549
+ "additionalProperties" : false,
1550
+ "properties" : {
1551
+ "totalTicketCount" : {
1552
+ "type" : [ "string", "null", "integer" ],
1553
+ "format" : "int64",
1554
+ "pattern" : "([0-9]+)"
1555
+ },
1556
+ "ticketCount" : {
1557
+ "$ref" : "./DashboardMetrics.json#/components/schemas/ticketCountArray"
1558
+ },
1559
+ "groupedBy" : {
1560
+ "type" : [ "string", "null" ],
1561
+ "enum" : [ "date", "channel", "agent", "hour" ],
1562
+ "maxLength" : 100,
1563
+ "minLength" : 0,
1564
+ "x-custom-parameters-attributes" : {
1565
+ "removeExif" : false,
1566
+ "filterMatchedContent" : false,
1567
+ "antivirus" : false,
1568
+ "replacementString" : "",
1569
+ "allowInvalid" : false,
1570
+ "descrption" : "To get created tickets count via particular group.This value can be @date@ @channel@ @agent@ | @hour@",
1571
+ "secret" : false,
1572
+ "preserveCharsLimit" : 10,
1573
+ "trim" : false,
1574
+ "internalParam" : false,
1575
+ "preserveChars" : "0,5",
1576
+ "importUrl" : false,
1577
+ "decrypt" : false
1578
+ }
1579
+ }
1580
+ },
1581
+ "required" : [ "groupedBy", "ticketCount", "totalTicketCount" ]
1582
+ },
1583
+ "examples" : {
1584
+ "Valid responses Definitions" : {
1585
+ "value" : {
1586
+ "totalTicketCount" : 5,
1587
+ "ticketCount" : [ {
1588
+ "statusInfo" : [ {
1589
+ "statusMapping" : "Open",
1590
+ "count" : 2,
1591
+ "status" : "open"
1592
+ } ],
1593
+ "value" : "2018-04-02"
1594
+ }, {
1595
+ "statusInfo" : [ {
1596
+ "statusMapping" : "Onhold",
1597
+ "count" : 2,
1598
+ "status" : "onhold"
1599
+ } ],
1600
+ "value" : "2018-04-03"
1601
+ }, {
1602
+ "statusInfo" : [ {
1603
+ "statusMapping" : "Closed",
1604
+ "count" : 1,
1605
+ "status" : "closed"
1606
+ } ],
1607
+ "value" : "2018-04-04"
1608
+ }, {
1609
+ "statusInfo" : [ ],
1610
+ "value" : "2018-04-05"
1611
+ }, {
1612
+ "statusInfo" : [ ],
1613
+ "value" : "2018-04-06"
1614
+ }, {
1615
+ "statusInfo" : [ ],
1616
+ "value" : "2018-04-07"
1617
+ }, {
1618
+ "statusInfo" : [ ],
1619
+ "value" : "2018-04-08"
1620
+ } ],
1621
+ "groupedBy" : "date"
1622
+ }
1623
+ }
1624
+ }
1625
+ }
1626
+ },
1627
+ "x-custom-response-attributes" : {
1628
+ "disable-safe-headers" : "[]"
1629
+ }
1630
+ },
1631
+ "inferenceMetrics" : {
1632
+ "description" : "inferenceMetrics template definitions",
1633
+ "content" : {
1634
+ "application/json" : {
1635
+ "schema" : {
1636
+ "type" : [ "object", "null" ],
1637
+ "additionalProperties" : false,
1638
+ "properties" : {
1639
+ "totalMissedPredictionsCount" : {
1640
+ "type" : [ "string", "null", "integer" ],
1641
+ "format" : "int64",
1642
+ "pattern" : "([0-9]+)"
1643
+ },
1644
+ "totalIncomingResponsesCount" : {
1645
+ "type" : [ "string", "null", "integer" ],
1646
+ "format" : "int64",
1647
+ "pattern" : "([0-9]+)"
1648
+ },
1649
+ "groupedBy" : {
1650
+ "type" : [ "string", "null" ],
1651
+ "maxLength" : 100,
1652
+ "minLength" : 0,
1653
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1654
+ },
1655
+ "totalOverriddenPredictionsCount" : {
1656
+ "type" : [ "string", "null", "integer" ],
1657
+ "format" : "int64",
1658
+ "pattern" : "([0-9]+)"
1659
+ },
1660
+ "predictionMetrics" : {
1661
+ "$ref" : "./DashboardMetrics.json#/components/schemas/ziaInferenceMetricsArray"
1662
+ },
1663
+ "totalPredictionsCount" : {
1664
+ "type" : [ "string", "null", "integer" ],
1665
+ "format" : "int64",
1666
+ "pattern" : "([0-9]+)"
1667
+ }
1668
+ },
1669
+ "required" : [ "groupedBy", "predictionMetrics", "totalIncomingResponsesCount", "totalMissedPredictionsCount", "totalOverriddenPredictionsCount", "totalPredictionsCount" ]
1670
+ },
1671
+ "examples" : {
1672
+ "Valid responses Definitions" : {
1673
+ "value" : {
1674
+ "totalMissedPredictionsCount" : "1",
1675
+ "totalIncomingResponsesCount" : "5",
1676
+ "totalOverriddenPredictionsCount" : "1",
1677
+ "predictionMetrics" : [ {
1678
+ "overriddenPredictionsCount" : "0",
1679
+ "missedPredictionsCount" : "0",
1680
+ "predictionsCount" : "0",
1681
+ "value" : "2022-06-29",
1682
+ "incomingResponsesCount" : "0"
1683
+ }, {
1684
+ "overriddenPredictionsCount" : "0",
1685
+ "missedPredictionsCount" : "0",
1686
+ "predictionsCount" : "0",
1687
+ "value" : "2022-06-30",
1688
+ "incomingResponsesCount" : "0"
1689
+ }, {
1690
+ "overriddenPredictionsCount" : "0",
1691
+ "missedPredictionsCount" : "0",
1692
+ "predictionsCount" : "0",
1693
+ "value" : "2022-07-01",
1694
+ "incomingResponsesCount" : "0"
1695
+ }, {
1696
+ "overriddenPredictionsCount" : "0",
1697
+ "missedPredictionsCount" : "0",
1698
+ "predictionsCount" : "0",
1699
+ "value" : "2022-07-02",
1700
+ "incomingResponsesCount" : "0"
1701
+ }, {
1702
+ "overriddenPredictionsCount" : "0",
1703
+ "missedPredictionsCount" : "0",
1704
+ "predictionsCount" : "0",
1705
+ "value" : "2022-07-03",
1706
+ "incomingResponsesCount" : "0"
1707
+ }, {
1708
+ "overriddenPredictionsCount" : "0",
1709
+ "missedPredictionsCount" : "1",
1710
+ "predictionsCount" : "0",
1711
+ "value" : "2022-07-04",
1712
+ "incomingResponsesCount" : "1"
1713
+ }, {
1714
+ "overriddenPredictionsCount" : "1",
1715
+ "missedPredictionsCount" : "0",
1716
+ "predictionsCount" : "3",
1717
+ "value" : "2022-07-05",
1718
+ "incomingResponsesCount" : "4"
1719
+ } ],
1720
+ "totalPredictionsCount" : "3"
1721
+ }
1722
+ }
1723
+ }
1724
+ }
1725
+ },
1726
+ "x-custom-response-attributes" : {
1727
+ "disable-safe-headers" : "[]"
1728
+ }
1729
+ },
1730
+ "slaDashboard" : {
1731
+ "description" : "slaDashboard template definitions",
1732
+ "content" : {
1733
+ "application/json" : {
1734
+ "schema" : {
1735
+ "type" : [ "object", "null" ],
1736
+ "additionalProperties" : false,
1737
+ "properties" : {
1738
+ "totalSlaViolation" : {
1739
+ "type" : [ "string", "null", "integer" ],
1740
+ "format" : "int64",
1741
+ "pattern" : "([0-9]+)"
1742
+ },
1743
+ "totalSlaSuccess" : {
1744
+ "type" : [ "string", "null", "integer" ],
1745
+ "format" : "int64",
1746
+ "pattern" : "([0-9]+)"
1747
+ },
1748
+ "slaMetricsData" : {
1749
+ "$ref" : "./DashboardMetrics.json#/components/schemas/slaMetricsData"
1750
+ },
1751
+ "groupedBy" : {
1752
+ "type" : [ "string", "null" ],
1753
+ "maxLength" : 100,
1754
+ "minLength" : 0,
1755
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1756
+ },
1757
+ "totalFullFillTime" : {
1758
+ "type" : [ "string", "null", "integer" ],
1759
+ "format" : "int64",
1760
+ "pattern" : "([0-9]+)"
1761
+ },
1762
+ "totalBreachTime" : {
1763
+ "type" : [ "string", "null", "integer" ],
1764
+ "format" : "int64",
1765
+ "pattern" : "([0-9]+)"
1766
+ }
1767
+ },
1768
+ "required" : [ "groupedBy", "slaMetricsData", "totalBreachTime", "totalFullFillTime", "totalSlaSuccess", "totalSlaViolation" ]
1769
+ },
1770
+ "examples" : {
1771
+ "Valid responses Definitions" : {
1772
+ "value" : {
1773
+ "totalSlaViolation" : "5",
1774
+ "totalSlaSuccess" : "5",
1775
+ "slaMetricsData" : [ {
1776
+ "violationCount" : "5",
1777
+ "violatedTicketsCount" : "1",
1778
+ "breachTime" : "600000",
1779
+ "referanceValue" : null,
1780
+ "fulfillTime" : "600000",
1781
+ "successCount" : "5",
1782
+ "succeededTicketsCount" : "1",
1783
+ "value" : "2018-04-01"
1784
+ }, {
1785
+ "violationCount" : "5",
1786
+ "violatedTicketsCount" : "1",
1787
+ "breachTime" : "1200000",
1788
+ "referanceValue" : null,
1789
+ "fulfillTime" : "1200000",
1790
+ "successCount" : "5",
1791
+ "succeededTicketsCount" : "1",
1792
+ "value" : "2018-04-02"
1793
+ } ],
1794
+ "groupedBy" : "date",
1795
+ "totalFulfillTime" : "600000",
1796
+ "totalBreachTime" : "600000"
1797
+ }
1798
+ }
1799
+ }
1800
+ }
1801
+ },
1802
+ "x-custom-response-attributes" : {
1803
+ "disable-safe-headers" : "[]"
1804
+ }
1805
+ },
1806
+ "resolutionTime" : {
1807
+ "description" : "resolutionTime template definitions",
1808
+ "content" : {
1809
+ "application/json" : {
1810
+ "schema" : {
1811
+ "type" : [ "object", "null" ],
1812
+ "additionalProperties" : false,
1813
+ "properties" : {
1814
+ "totalAvgAgentTime" : {
1815
+ "type" : [ "string", "null" ],
1816
+ "maxLength" : 100,
1817
+ "minLength" : 0,
1818
+ "pattern" : "((^([0-9]*):([0-5][0-9]) hrs$)|null|undefined)"
1819
+ },
1820
+ "timeData" : {
1821
+ "$ref" : "./DashboardMetrics.json#/components/schemas/resolutionTimeArray"
1822
+ },
1823
+ "totalTicketCount" : {
1824
+ "type" : [ "string", "null", "integer" ],
1825
+ "format" : "int64",
1826
+ "pattern" : "([0-9]+)"
1827
+ },
1828
+ "totalAvgSystemTime" : {
1829
+ "type" : [ "string", "null" ],
1830
+ "maxLength" : 100,
1831
+ "minLength" : 0,
1832
+ "pattern" : "((^([0-9]*):([0-5][0-9]) hrs$)|null|undefined)"
1833
+ },
1834
+ "groupedBy" : {
1835
+ "type" : [ "string", "null" ],
1836
+ "enum" : [ "date", "channel", "agent", "hour" ],
1837
+ "maxLength" : 100,
1838
+ "minLength" : 0,
1839
+ "x-custom-parameters-attributes" : {
1840
+ "removeExif" : false,
1841
+ "filterMatchedContent" : false,
1842
+ "antivirus" : false,
1843
+ "replacementString" : "",
1844
+ "allowInvalid" : false,
1845
+ "descrption" : "Key that groups stats according to a specific attribute: date, channel, agent, or hour",
1846
+ "secret" : false,
1847
+ "preserveCharsLimit" : 10,
1848
+ "trim" : false,
1849
+ "internalParam" : false,
1850
+ "preserveChars" : "0,5",
1851
+ "importUrl" : false,
1852
+ "decrypt" : false
1853
+ }
1854
+ }
1855
+ },
1856
+ "required" : [ "groupedBy", "timeData", "totalAvgAgentTime", "totalAvgSystemTime", "totalTicketCount" ]
1857
+ },
1858
+ "examples" : {
1859
+ "Valid responses Definitions" : {
1860
+ "value" : {
1861
+ "totalAvgAgentTime" : "41:50 hrs",
1862
+ "timeData" : [ {
1863
+ "avgSystemTime" : "41:50 hrs",
1864
+ "ticketCount" : "1",
1865
+ "avgAgentTime" : "41:50 hrs",
1866
+ "value" : "Priyanka",
1867
+ "referenceValue" : "4000000012629"
1868
+ } ],
1869
+ "totalTicketCount" : "1",
1870
+ "totalAvgSystemTime" : "41:50 hrs",
1871
+ "groupedBy" : "agent"
1872
+ }
1873
+ }
1874
+ }
1875
+ }
1876
+ },
1877
+ "x-custom-response-attributes" : {
1878
+ "disable-safe-headers" : "[]"
1879
+ }
1880
+ },
1881
+ "slaOverViewMetrics" : {
1882
+ "description" : "slaOverViewMetrics template definitions",
1883
+ "content" : {
1884
+ "application/json" : {
1885
+ "schema" : {
1886
+ "type" : [ "object", "null" ],
1887
+ "additionalProperties" : false,
1888
+ "properties" : {
1889
+ "totalSlaViolation" : {
1890
+ "type" : [ "string", "null", "integer" ],
1891
+ "format" : "int64",
1892
+ "pattern" : "([0-9]+)"
1893
+ },
1894
+ "totalSlaSuccess" : {
1895
+ "type" : [ "string", "null", "integer" ],
1896
+ "format" : "int64",
1897
+ "pattern" : "([0-9]+)"
1898
+ },
1899
+ "totalSlaViolatedTickets" : {
1900
+ "type" : [ "string", "null", "integer" ],
1901
+ "format" : "int64",
1902
+ "pattern" : "([0-9]+)"
1903
+ },
1904
+ "totalFulfillTime" : {
1905
+ "type" : [ "string", "null", "integer" ],
1906
+ "format" : "int64",
1907
+ "pattern" : "([0-9]+)"
1908
+ },
1909
+ "totalSlaSucceededTickets" : {
1910
+ "type" : [ "string", "null", "integer" ],
1911
+ "format" : "int64",
1912
+ "pattern" : "([0-9]+)"
1913
+ },
1914
+ "totalBreachTime" : {
1915
+ "type" : [ "string", "null", "integer" ],
1916
+ "format" : "int64",
1917
+ "pattern" : "([0-9]+)"
1918
+ }
1919
+ },
1920
+ "required" : [ "totalBreachTime", "totalFulfillTime", "totalSlaSucceededTickets", "totalSlaSuccess", "totalSlaViolatedTickets", "totalSlaViolation" ]
1921
+ },
1922
+ "examples" : {
1923
+ "Valid responses Definitions" : {
1924
+ "value" : {
1925
+ "totalSlaSuccess" : "0",
1926
+ "totalSlaViolation" : "19",
1927
+ "totalSlaViolatedTickets" : "2",
1928
+ "totalFulfillTime" : "0",
1929
+ "totalSlaSucceededTickets" : "0",
1930
+ "totalBreachTime" : "2880000"
1931
+ }
1932
+ }
1933
+ }
1934
+ }
1935
+ },
1936
+ "x-custom-response-attributes" : {
1937
+ "disable-safe-headers" : "[]"
1938
+ }
1939
+ },
1940
+ "responseCount" : {
1941
+ "description" : "responseCount template definitions",
1942
+ "content" : {
1943
+ "application/json" : {
1944
+ "schema" : {
1945
+ "type" : [ "object", "null" ],
1946
+ "additionalProperties" : false,
1947
+ "properties" : {
1948
+ "avg" : {
1949
+ "type" : [ "string", "null" ],
1950
+ "maxLength" : 100,
1951
+ "minLength" : 0,
1952
+ "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
1953
+ },
1954
+ "groupedBy" : {
1955
+ "type" : [ "string", "null" ],
1956
+ "enum" : [ "date", "channel", "agent", "hour" ],
1957
+ "maxLength" : 100,
1958
+ "minLength" : 0,
1959
+ "x-custom-parameters-attributes" : {
1960
+ "removeExif" : false,
1961
+ "filterMatchedContent" : false,
1962
+ "antivirus" : false,
1963
+ "replacementString" : "",
1964
+ "allowInvalid" : false,
1965
+ "descrption" : "Key that groups the thread count according to a particular attribute.This value can be @date@ @channel@ @agent@ | @hour@",
1966
+ "secret" : false,
1967
+ "preserveCharsLimit" : 10,
1968
+ "trim" : false,
1969
+ "internalParam" : false,
1970
+ "preserveChars" : "0,5",
1971
+ "importUrl" : false,
1972
+ "decrypt" : false
1973
+ }
1974
+ },
1975
+ "totalResponseCount" : {
1976
+ "type" : [ "string", "null", "integer" ],
1977
+ "format" : "int64",
1978
+ "pattern" : "([0-9]+)"
1979
+ },
1980
+ "responseCount" : {
1981
+ "$ref" : "./DashboardMetrics.json#/components/schemas/countArray"
1982
+ }
1983
+ },
1984
+ "required" : [ "avg", "groupedBy", "responseCount", "totalResponseCount" ]
1985
+ },
1986
+ "examples" : {
1987
+ "Valid responses Definitions" : {
1988
+ "value" : {
1989
+ "avg" : "0.0",
1990
+ "groupedBy" : "date",
1991
+ "totalResponseCount" : "0",
1992
+ "responseCount" : [ {
1993
+ "count" : "0",
1994
+ "value" : "2018-04-06",
1995
+ "referenceValue" : null
1996
+ }, {
1997
+ "count" : "0",
1998
+ "value" : "2018-04-07",
1999
+ "referenceValue" : null
2000
+ }, {
2001
+ "count" : "0",
2002
+ "value" : "2018-04-08",
2003
+ "referenceValue" : null
2004
+ }, {
2005
+ "count" : "0",
2006
+ "value" : "2018-04-09",
2007
+ "referenceValue" : null
2008
+ }, {
2009
+ "count" : "0",
2010
+ "value" : "2018-04-10",
2011
+ "referenceValue" : null
2012
+ } ]
2013
+ }
2014
+ }
2015
+ }
2016
+ }
2017
+ },
2018
+ "x-custom-response-attributes" : {
2019
+ "disable-safe-headers" : "[]"
2020
+ }
2021
+ },
2022
+ "responseTime" : {
2023
+ "description" : "responseTime template definitions",
2024
+ "content" : {
2025
+ "application/json" : {
2026
+ "schema" : {
2027
+ "type" : [ "object", "null" ],
2028
+ "additionalProperties" : false,
2029
+ "properties" : {
2030
+ "totalAvgAgentTime" : {
2031
+ "type" : [ "string", "null" ],
2032
+ "maxLength" : 100,
2033
+ "minLength" : 0,
2034
+ "pattern" : "((^([0-9]*):([0-5][0-9]) hrs$)|null|undefined)"
2035
+ },
2036
+ "timeData" : {
2037
+ "$ref" : "./DashboardMetrics.json#/components/schemas/responseTimeArray"
2038
+ },
2039
+ "totalAvgSystemTime" : {
2040
+ "type" : [ "string", "null" ],
2041
+ "maxLength" : 100,
2042
+ "minLength" : 0,
2043
+ "pattern" : "((^([0-9]*):([0-5][0-9]) hrs$)|null|undefined)"
2044
+ },
2045
+ "groupedBy" : {
2046
+ "type" : [ "string", "null" ],
2047
+ "enum" : [ "date", "channel", "agent", "hour" ],
2048
+ "maxLength" : 100,
2049
+ "minLength" : 0,
2050
+ "x-custom-parameters-attributes" : {
2051
+ "removeExif" : false,
2052
+ "filterMatchedContent" : false,
2053
+ "antivirus" : false,
2054
+ "replacementString" : "",
2055
+ "allowInvalid" : false,
2056
+ "descrption" : "Key that groups stats according to a specific attribute: date, channel, agent, or hour",
2057
+ "secret" : false,
2058
+ "preserveCharsLimit" : 10,
2059
+ "trim" : false,
2060
+ "internalParam" : false,
2061
+ "preserveChars" : "0,5",
2062
+ "importUrl" : false,
2063
+ "decrypt" : false
2064
+ }
2065
+ },
2066
+ "totalResponseCount" : {
2067
+ "type" : [ "string", "null", "integer" ],
2068
+ "format" : "int64",
2069
+ "pattern" : "([0-9]+)"
2070
+ }
2071
+ },
2072
+ "required" : [ "groupedBy", "timeData", "totalAvgAgentTime", "totalAvgSystemTime", "totalResponseCount" ]
2073
+ },
2074
+ "examples" : {
2075
+ "Valid responses Definitions" : {
2076
+ "value" : {
2077
+ "totalAvgAgentTime" : "41:50 hrs",
2078
+ "timeData" : [ {
2079
+ "avgSystemTime" : "00:00 hrs",
2080
+ "avgAgentTime" : "00:00 hrs",
2081
+ "responseCount" : "0",
2082
+ "value" : "Feedback Widget",
2083
+ "referenceValue" : null
2084
+ }, {
2085
+ "avgSystemTime" : "00:00 hrs",
2086
+ "avgAgentTime" : "00:00 hrs",
2087
+ "responseCount" : "0",
2088
+ "value" : "Email",
2089
+ "referenceValue" : null
2090
+ }, {
2091
+ "avgSystemTime" : "00:00 hrs",
2092
+ "avgAgentTime" : "00:00 hrs",
2093
+ "responseCount" : "0",
2094
+ "value" : "Web",
2095
+ "referenceValue" : null
2096
+ }, {
2097
+ "avgSystemTime" : "41:50 hrs",
2098
+ "avgAgentTime" : "41:50 hrs",
2099
+ "responseCount" : "1",
2100
+ "value" : "Phone",
2101
+ "referenceValue" : null
2102
+ }, {
2103
+ "avgSystemTime" : "00:00 hrs",
2104
+ "avgAgentTime" : "00:00 hrs",
2105
+ "responseCount" : "0",
2106
+ "value" : "Forums",
2107
+ "referenceValue" : null
2108
+ }, {
2109
+ "avgSystemTime" : "00:00 hrs",
2110
+ "avgAgentTime" : "00:00 hrs",
2111
+ "responseCount" : "0",
2112
+ "value" : "Chat",
2113
+ "referenceValue" : null
2114
+ }, {
2115
+ "avgSystemTime" : "00:00 hrs",
2116
+ "avgAgentTime" : "00:00 hrs",
2117
+ "responseCount" : "0",
2118
+ "value" : "Twitter",
2119
+ "referenceValue" : null
2120
+ }, {
2121
+ "avgSystemTime" : "00:00 hrs",
2122
+ "avgAgentTime" : "00:00 hrs",
2123
+ "responseCount" : "0",
2124
+ "value" : "Facebook",
2125
+ "referenceValue" : null
2126
+ } ],
2127
+ "totalAvgSystemTime" : "41:50 hrs",
2128
+ "groupedBy" : "channel",
2129
+ "totalResponseCount" : "1"
2130
+ }
2131
+ }
2132
+ }
2133
+ }
2134
+ },
2135
+ "x-custom-response-attributes" : {
2136
+ "disable-safe-headers" : "[]"
2137
+ }
2138
+ }
2139
+ },
2140
+ "parameters" : {
2141
+ "duration" : {
2142
+ "name" : "duration",
2143
+ "in" : "query",
2144
+ "description" : "Predefined time range from which the stats must be fetched",
2145
+ "required" : true,
2146
+ "style" : "form",
2147
+ "explode" : true,
2148
+ "schema" : {
2149
+ "type" : [ "string", "null" ],
2150
+ "description" : "Predefined time range from which the stats must be fetched",
2151
+ "enum" : [ "LAST_30_DAYS", "LAST_7_DAYS", "THIS_WEEK", "LAST_WEEK", "THIS_MONTH", "LAST_MONTH" ],
2152
+ "maxLength" : 100,
2153
+ "minLength" : 0
2154
+ }
2155
+ },
2156
+ "agentId" : {
2157
+ "name" : "agentId",
2158
+ "in" : "query",
2159
+ "description" : "ID(s) of the agent(s) whose stats must be fetched",
2160
+ "required" : false,
2161
+ "style" : "form",
2162
+ "explode" : true,
2163
+ "schema" : {
2164
+ "type" : [ "string", "null", "integer" ],
2165
+ "format" : "int64",
2166
+ "description" : "ID(s) of the agent(s) whose stats must be fetched",
2167
+ "pattern" : "([0-9]+)",
2168
+ "x-custom-parameters-attributes" : {
2169
+ "split" : ","
2170
+ }
2171
+ }
2172
+ },
2173
+ "slaId" : {
2174
+ "name" : "slaId",
2175
+ "in" : "query",
2176
+ "description" : "list of SLA ids separated by commas.When slaid is not given,data for all sla is given",
2177
+ "required" : false,
2178
+ "style" : "form",
2179
+ "explode" : true,
2180
+ "schema" : {
2181
+ "type" : [ "string", "null", "integer" ],
2182
+ "format" : "int64",
2183
+ "description" : "list of SLA ids separated by commas.When slaid is not given,data for all sla is given",
2184
+ "pattern" : "([0-9]+)",
2185
+ "x-custom-parameters-attributes" : {
2186
+ "split" : ","
2187
+ }
2188
+ }
2189
+ },
2190
+ "violationType" : {
2191
+ "name" : "violationType",
2192
+ "in" : "query",
2193
+ "description" : "To get sla metrics count for a particular SLA type. This value can be @FIRST_RESPONSE@ @RESPONSE@ @RESOLUTION@ @ALL@",
2194
+ "required" : true,
2195
+ "style" : "form",
2196
+ "explode" : true,
2197
+ "schema" : {
2198
+ "type" : [ "string", "null" ],
2199
+ "description" : "To get sla metrics count for a particular SLA type. This value can be @FIRST_RESPONSE@ @RESPONSE@ @RESOLUTION@ @ALL@",
2200
+ "enum" : [ "ALL", "FIRST_RESPONSE", "RESPONSE", "RESOLUTION" ],
2201
+ "maxLength" : 100,
2202
+ "minLength" : 0
2203
+ }
2204
+ },
2205
+ "departmentId" : {
2206
+ "name" : "departmentId",
2207
+ "in" : "query",
2208
+ "description" : "ID(s) of the department(s) from which the stats must be fetched",
2209
+ "required" : false,
2210
+ "style" : "form",
2211
+ "explode" : true,
2212
+ "schema" : {
2213
+ "type" : [ "string", "null", "integer" ],
2214
+ "format" : "int64",
2215
+ "description" : "ID(s) of the department(s) from which the stats must be fetched",
2216
+ "pattern" : "([0-9]+)",
2217
+ "x-custom-parameters-attributes" : {
2218
+ "split" : ","
2219
+ }
2220
+ }
2221
+ },
2222
+ "sortOrder" : {
2223
+ "name" : "sortOrder",
2224
+ "in" : "query",
2225
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent.",
2226
+ "required" : false,
2227
+ "style" : "form",
2228
+ "explode" : true,
2229
+ "schema" : {
2230
+ "type" : [ "boolean", "null" ],
2231
+ "description" : "Key that defines the sorting order for the data in the response. TRUE sets ascending order of sorting and FALSE sets descending order of sorting. This key is applicable only if the data is also grouped by agent."
2232
+ }
2233
+ },
2234
+ "teamId" : {
2235
+ "name" : "teamId",
2236
+ "in" : "query",
2237
+ "description" : "ID(s) of the team(s) from which the stats must be fetched",
2238
+ "required" : false,
2239
+ "style" : "form",
2240
+ "explode" : true,
2241
+ "schema" : {
2242
+ "type" : [ "string", "null", "integer" ],
2243
+ "format" : "int64",
2244
+ "description" : "ID(s) of the team(s) from which the stats must be fetched",
2245
+ "pattern" : "([0-9]+)",
2246
+ "x-custom-parameters-attributes" : {
2247
+ "split" : ","
2248
+ }
2249
+ }
2250
+ },
2251
+ "channel" : {
2252
+ "name" : "channel",
2253
+ "in" : "query",
2254
+ "description" : "Channel through which the tickets were received",
2255
+ "required" : false,
2256
+ "style" : "form",
2257
+ "explode" : true,
2258
+ "schema" : {
2259
+ "type" : [ "string", "null" ],
2260
+ "description" : "Channel through which the tickets were received",
2261
+ "x-dynamic-enum" : true
2262
+ }
2263
+ },
2264
+ "groupBy" : {
2265
+ "name" : "groupBy",
2266
+ "in" : "query",
2267
+ "description" : "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@",
2268
+ "required" : true,
2269
+ "style" : "form",
2270
+ "explode" : true,
2271
+ "schema" : {
2272
+ "type" : [ "string", "null" ],
2273
+ "description" : "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@",
2274
+ "enum" : [ "date", "channel", "agent", "hour" ],
2275
+ "maxLength" : 100,
2276
+ "minLength" : 0
2277
+ }
2278
+ },
2279
+ "predictionId" : {
2280
+ "name" : "predictionId",
2281
+ "in" : "query",
2282
+ "description" : "ID of Prediction for which the stats must be fetched",
2283
+ "required" : true,
2284
+ "style" : "form",
2285
+ "explode" : true,
2286
+ "schema" : {
2287
+ "type" : [ "string", "null", "integer" ],
2288
+ "format" : "int64",
2289
+ "description" : "ID of Prediction for which the stats must be fetched",
2290
+ "pattern" : "([0-9]+)"
2291
+ }
2292
+ }
2293
+ },
2294
+ "securitySchemes" : {
2295
+ "cookie-auth" : {
2296
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
2297
+ },
2298
+ "org-oauth" : {
2299
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
2300
+ },
2301
+ "jwt-oauth" : {
2302
+ "$ref" : "../common/Common.json#/components/securitySchemes/jwt-oauth"
2303
+ },
2304
+ "iam-oauth2-schema" : {
2305
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
2306
+ }
2307
+ }
2308
+ },
2309
+ "x-entity" : "DashboardMetrics"
2310
+ }