agent-generator 1.0.3 → 1.0.5

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 (770) hide show
  1. package/install-extension.js +1 -1
  2. package/package.json +2 -4
  3. package/Generator_Patterns/Conditional.md +0 -84
  4. package/Generator_Patterns/Dynamic.md +0 -129
  5. package/Generator_Patterns/PathConfig.properties +0 -4
  6. package/Generator_Patterns/README.md +0 -118
  7. package/Generator_Patterns/Reference.md +0 -98
  8. package/Generator_Patterns/Remote.md +0 -259
  9. package/Generator_Patterns/Static.md +0 -99
  10. package/source/api-data-generators/.idea/api-data-generators.iml +0 -9
  11. package/source/api-data-generators/.idea/misc.xml +0 -6
  12. package/source/api-data-generators/.idea/modules.xml +0 -8
  13. package/source/api-data-generators/.idea/vcs.xml +0 -6
  14. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +0 -318
  15. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +0 -32
  16. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +0 -21
  17. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +0 -18
  18. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +0 -39
  19. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +0 -157
  20. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +0 -46
  21. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +0 -16
  22. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +0 -33
  23. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +0 -13
  24. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +0 -91
  25. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +0 -18
  26. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +0 -42
  27. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +0 -92
  28. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +0 -51
  29. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +0 -11
  30. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +0 -41
  31. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +0 -18
  32. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +0 -76
  33. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +0 -51
  34. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +0 -25
  35. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +0 -26
  36. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +0 -18
  37. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +0 -17
  38. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +0 -17
  39. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +0 -21
  40. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +0 -32
  41. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +0 -43
  42. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +0 -631
  43. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +0 -70
  44. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +0 -294
  45. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +0 -58
  46. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +0 -74
  47. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +0 -11
  48. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +0 -24
  49. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +0 -259
  50. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +0 -6
  51. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +0 -14
  52. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +0 -19
  53. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +0 -265
  54. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +0 -48
  55. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +0 -47
  56. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +0 -14
  57. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +0 -52
  58. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +0 -33
  59. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +0 -45
  60. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +0 -38
  61. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +0 -50
  62. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +0 -22
  63. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +0 -217
  64. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +0 -30
  65. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +0 -31
  66. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +0 -36
  67. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +0 -32
  68. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +0 -49
  69. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +0 -66
  70. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +0 -294
  71. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +0 -150
  72. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +0 -238
  73. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +0 -147
  74. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +0 -56
  75. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +0 -397
  76. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +0 -1123
  77. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +0 -26
  78. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +0 -26
  79. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +0 -49
  80. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +0 -58
  81. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +0 -27
  82. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +0 -20
  83. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +0 -13
  84. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +0 -24
  85. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +0 -29
  86. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +0 -115
  87. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +0 -64
  88. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +0 -288
  89. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +0 -119
  90. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +0 -37
  91. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +0 -26
  92. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +0 -211
  93. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +0 -40
  94. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +0 -32
  95. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +0 -72
  96. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +0 -247
  97. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +0 -51
  98. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +0 -65
  99. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +0 -77
  100. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +0 -14
  101. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +0 -44
  102. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +0 -35
  103. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +0 -185
  104. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +0 -43
  105. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +0 -313
  106. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +0 -16
  107. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +0 -121
  108. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +0 -350
  109. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +0 -16
  110. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +0 -19
  111. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +0 -509
  112. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +0 -32
  113. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +0 -63
  114. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +0 -370
  115. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +0 -44
  116. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +0 -47
  117. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +0 -52
  118. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +0 -11
  119. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +0 -45
  120. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +0 -184
  121. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +0 -30
  122. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +0 -93
  123. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +0 -19
  124. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +0 -202
  125. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +0 -56
  126. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +0 -334
  127. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +0 -113
  128. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +0 -68
  129. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +0 -16
  130. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +0 -270
  131. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +0 -70
  132. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +0 -486
  133. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +0 -77
  134. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +0 -305
  135. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +0 -126
  136. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +0 -205
  137. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +0 -90
  138. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +0 -33
  139. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +0 -228
  140. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +0 -44
  141. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +0 -156
  142. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +0 -50
  143. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +0 -17
  144. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +0 -37
  145. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +0 -45
  146. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +0 -6
  147. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +0 -21
  148. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +0 -106
  149. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +0 -205
  150. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +0 -196
  151. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +0 -45
  152. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +0 -77
  153. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +0 -14
  154. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +0 -689
  155. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +0 -64
  156. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +0 -61
  157. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +0 -49
  158. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +0 -44
  159. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +0 -108
  160. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +0 -39
  161. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +0 -54
  162. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +0 -1031
  163. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +0 -564
  164. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +0 -36
  165. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +0 -180
  166. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +0 -60
  167. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +0 -26
  168. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +0 -240
  169. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +0 -16
  170. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +0 -216
  171. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +0 -168
  172. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +0 -29
  173. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +0 -98
  174. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +0 -11
  175. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +0 -93
  176. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +0 -34
  177. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +0 -18
  178. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +0 -25
  179. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +0 -65
  180. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +0 -155
  181. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +0 -92
  182. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +0 -22
  183. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +0 -19
  184. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +0 -143
  185. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +0 -39
  186. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +0 -312
  187. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +0 -35
  188. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +0 -16
  189. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +0 -32
  190. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +0 -297
  191. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +0 -38
  192. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +0 -56
  193. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +0 -149
  194. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +0 -77
  195. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +0 -52
  196. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +0 -229
  197. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +0 -16
  198. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +0 -90
  199. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +0 -25
  200. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +0 -66
  201. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +0 -49
  202. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +0 -23
  203. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +0 -131
  204. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +0 -214
  205. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +0 -30
  206. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +0 -173
  207. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +0 -21
  208. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +0 -93
  209. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +0 -103
  210. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +0 -503
  211. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +0 -19
  212. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +0 -334
  213. package/source/api-data-generators/support/License/test_data_generation_configurations.json +0 -60
  214. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +0 -72
  215. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +0 -34
  216. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +0 -184
  217. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +0 -32
  218. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +0 -38
  219. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +0 -38
  220. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +0 -50
  221. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +0 -16
  222. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +0 -96
  223. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +0 -26
  224. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +0 -19
  225. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +0 -20
  226. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +0 -27
  227. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +0 -19
  228. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +0 -29
  229. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +0 -79
  230. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +0 -109
  231. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +0 -66
  232. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +0 -113
  233. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +0 -28
  234. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +0 -17
  235. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +0 -54
  236. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +0 -54
  237. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +0 -77
  238. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +0 -14
  239. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +0 -32
  240. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +0 -66
  241. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +0 -64
  242. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +0 -32
  243. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +0 -196
  244. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +0 -48
  245. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +0 -59
  246. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +0 -37
  247. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +0 -239
  248. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +0 -52
  249. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +0 -52
  250. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +0 -538
  251. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +0 -28
  252. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +0 -100
  253. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +0 -29
  254. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +0 -84
  255. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +0 -58
  256. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +0 -50
  257. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +0 -29
  258. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +0 -22
  259. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +0 -42
  260. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +0 -92
  261. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +0 -46
  262. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +0 -50
  263. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +0 -22
  264. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +0 -203
  265. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +0 -172
  266. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +0 -182
  267. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +0 -636
  268. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +0 -32
  269. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +0 -32
  270. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +0 -62
  271. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +0 -24
  272. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +0 -164
  273. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +0 -21
  274. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +0 -60
  275. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +0 -51
  276. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +0 -40
  277. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +0 -47
  278. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +0 -22
  279. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +0 -223
  280. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +0 -22
  281. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +0 -76
  282. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +0 -104
  283. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +0 -43
  284. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +0 -65
  285. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +0 -29
  286. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +0 -97
  287. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +0 -219
  288. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +0 -42
  289. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +0 -45
  290. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +0 -87
  291. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +0 -27
  292. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +0 -115
  293. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +0 -72
  294. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +0 -383
  295. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +0 -694
  296. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +0 -66
  297. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +0 -58
  298. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +0 -82
  299. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +0 -43
  300. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +0 -65
  301. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +0 -16
  302. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +0 -99
  303. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +0 -475
  304. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +0 -110
  305. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +0 -48
  306. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +0 -91
  307. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +0 -46
  308. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +0 -68
  309. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +0 -54
  310. package/source/api-data-generators/support/User/test_data_generation_configurations.json +0 -100
  311. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +0 -49
  312. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +0 -19
  313. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +0 -19
  314. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +0 -321
  315. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +0 -501
  316. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +0 -166
  317. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +0 -26
  318. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +0 -38
  319. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +0 -22
  320. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +0 -19
  321. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +0 -22
  322. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +0 -33
  323. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +0 -71
  324. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +0 -859
  325. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +0 -26
  326. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +0 -652
  327. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +0 -21
  328. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +0 -50
  329. package/source/openapi-specifications/v1.0/common/Common.json +0 -587
  330. package/source/openapi-specifications/v1.0/portal/Account.json +0 -183
  331. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +0 -1103
  332. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +0 -133
  333. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +0 -712
  334. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +0 -91
  335. package/source/openapi-specifications/v1.0/portal/Attachment.json +0 -122
  336. package/source/openapi-specifications/v1.0/portal/Captcha.json +0 -334
  337. package/source/openapi-specifications/v1.0/portal/Category.json +0 -1061
  338. package/source/openapi-specifications/v1.0/portal/Comment.json +0 -1546
  339. package/source/openapi-specifications/v1.0/portal/Community.json +0 -235
  340. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +0 -296
  341. package/source/openapi-specifications/v1.0/portal/Contact.json +0 -536
  342. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +0 -163
  343. package/source/openapi-specifications/v1.0/portal/Department.json +0 -246
  344. package/source/openapi-specifications/v1.0/portal/Extension.json +0 -1122
  345. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +0 -96
  346. package/source/openapi-specifications/v1.0/portal/Field.json +0 -1239
  347. package/source/openapi-specifications/v1.0/portal/FileExport.json +0 -313
  348. package/source/openapi-specifications/v1.0/portal/Followers.json +0 -802
  349. package/source/openapi-specifications/v1.0/portal/Gamification.json +0 -819
  350. package/source/openapi-specifications/v1.0/portal/HashTags.json +0 -61
  351. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +0 -605
  352. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +0 -148
  353. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +0 -920
  354. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +0 -118
  355. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +0 -184
  356. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +0 -70
  357. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +0 -1310
  358. package/source/openapi-specifications/v1.0/portal/KbCategory.json +0 -1525
  359. package/source/openapi-specifications/v1.0/portal/KbSection.json +0 -515
  360. package/source/openapi-specifications/v1.0/portal/Label.json +0 -172
  361. package/source/openapi-specifications/v1.0/portal/Layout.json +0 -303
  362. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +0 -375
  363. package/source/openapi-specifications/v1.0/portal/Mentions.json +0 -580
  364. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +0 -699
  365. package/source/openapi-specifications/v1.0/portal/Permalink.json +0 -265
  366. package/source/openapi-specifications/v1.0/portal/Placeholders.json +0 -57
  367. package/source/openapi-specifications/v1.0/portal/Product.json +0 -401
  368. package/source/openapi-specifications/v1.0/portal/Solution.json +0 -3766
  369. package/source/openapi-specifications/v1.0/portal/Thread.json +0 -821
  370. package/source/openapi-specifications/v1.0/portal/Ticket.json +0 -2636
  371. package/source/openapi-specifications/v1.0/portal/TicketComment.json +0 -822
  372. package/source/openapi-specifications/v1.0/portal/TicketCount.json +0 -336
  373. package/source/openapi-specifications/v1.0/portal/TicketExport.json +0 -609
  374. package/source/openapi-specifications/v1.0/portal/TicketField.json +0 -358
  375. package/source/openapi-specifications/v1.0/portal/TicketForm.json +0 -517
  376. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +0 -155
  377. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +0 -409
  378. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +0 -175
  379. package/source/openapi-specifications/v1.0/portal/Topic.json +0 -4079
  380. package/source/openapi-specifications/v1.0/portal/Translation.json +0 -174
  381. package/source/openapi-specifications/v1.0/portal/Upload.json +0 -156
  382. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +0 -309
  383. package/source/openapi-specifications/v1.0/portal/View.json +0 -353
  384. package/source/openapi-specifications/v1.0/portal/Widget.json +0 -218
  385. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +0 -354
  386. package/source/openapi-specifications/v1.0/support/Account.json +0 -3206
  387. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +0 -484
  388. package/source/openapi-specifications/v1.0/support/AccountComments.json +0 -794
  389. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +0 -227
  390. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +0 -578
  391. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +0 -350
  392. package/source/openapi-specifications/v1.0/support/AccountSla.json +0 -341
  393. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +0 -1152
  394. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +0 -573
  395. package/source/openapi-specifications/v1.0/support/Activity.json +0 -1400
  396. package/source/openapi-specifications/v1.0/support/Actor.json +0 -88
  397. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +0 -304
  398. package/source/openapi-specifications/v1.0/support/AdminTool.json +0 -489
  399. package/source/openapi-specifications/v1.0/support/Agent.json +0 -6685
  400. package/source/openapi-specifications/v1.0/support/AgentPresence.json +0 -567
  401. package/source/openapi-specifications/v1.0/support/AgentRoom.json +0 -1997
  402. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +0 -359
  403. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +0 -1402
  404. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +0 -510
  405. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +0 -1189
  406. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +0 -543
  407. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +0 -155
  408. package/source/openapi-specifications/v1.0/support/ArchivedView.json +0 -469
  409. package/source/openapi-specifications/v1.0/support/Article.json +0 -5060
  410. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +0 -544
  411. package/source/openapi-specifications/v1.0/support/ArticleComment.json +0 -1929
  412. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +0 -56
  413. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +0 -1314
  414. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +0 -513
  415. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +0 -2510
  416. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +0 -3053
  417. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +0 -7530
  418. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +0 -184
  419. package/source/openapi-specifications/v1.0/support/ArticleViews.json +0 -564
  420. package/source/openapi-specifications/v1.0/support/Asap.json +0 -1525
  421. package/source/openapi-specifications/v1.0/support/AsapModule.json +0 -246
  422. package/source/openapi-specifications/v1.0/support/AsapStatus.json +0 -199
  423. package/source/openapi-specifications/v1.0/support/AssistInteg.json +0 -613
  424. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +0 -786
  425. package/source/openapi-specifications/v1.0/support/AuditLog.json +0 -1122
  426. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +0 -702
  427. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +0 -868
  428. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +0 -1181
  429. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +0 -207
  430. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +0 -809
  431. package/source/openapi-specifications/v1.0/support/AutomationTask.json +0 -1054
  432. package/source/openapi-specifications/v1.0/support/Backup.json +0 -2845
  433. package/source/openapi-specifications/v1.0/support/Badge.json +0 -544
  434. package/source/openapi-specifications/v1.0/support/Bot.json +0 -2103
  435. package/source/openapi-specifications/v1.0/support/BotInference.json +0 -1071
  436. package/source/openapi-specifications/v1.0/support/BotResources.json +0 -175
  437. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +0 -541
  438. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +0 -63
  439. package/source/openapi-specifications/v1.0/support/Bots.json +0 -58
  440. package/source/openapi-specifications/v1.0/support/BugInteg.json +0 -481
  441. package/source/openapi-specifications/v1.0/support/BulkAction.json +0 -150
  442. package/source/openapi-specifications/v1.0/support/BulkImport.json +0 -2845
  443. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +0 -743
  444. package/source/openapi-specifications/v1.0/support/BulkWrite.json +0 -678
  445. package/source/openapi-specifications/v1.0/support/BusinessHour.json +0 -1344
  446. package/source/openapi-specifications/v1.0/support/Call.json +0 -3839
  447. package/source/openapi-specifications/v1.0/support/CallComments.json +0 -721
  448. package/source/openapi-specifications/v1.0/support/CallHistory.json +0 -936
  449. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +0 -1745
  450. package/source/openapi-specifications/v1.0/support/CallTimer.json +0 -285
  451. package/source/openapi-specifications/v1.0/support/Channel.json +0 -730
  452. package/source/openapi-specifications/v1.0/support/Chart.json +0 -422
  453. package/source/openapi-specifications/v1.0/support/ChatTicket.json +0 -553
  454. package/source/openapi-specifications/v1.0/support/ClientAction.json +0 -1834
  455. package/source/openapi-specifications/v1.0/support/ClientEvent.json +0 -780
  456. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +0 -1123
  457. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +0 -528
  458. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +0 -44
  459. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +0 -94
  460. package/source/openapi-specifications/v1.0/support/Community.json +0 -2545
  461. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +0 -249
  462. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +0 -1896
  463. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +0 -145
  464. package/source/openapi-specifications/v1.0/support/CommunityComment.json +0 -2492
  465. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +0 -129
  466. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +0 -343
  467. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +0 -78
  468. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +0 -6005
  469. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +0 -310
  470. package/source/openapi-specifications/v1.0/support/CommunityUser.json +0 -822
  471. package/source/openapi-specifications/v1.0/support/Composite.json +0 -414
  472. package/source/openapi-specifications/v1.0/support/Contact.json +0 -4691
  473. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +0 -484
  474. package/source/openapi-specifications/v1.0/support/ContactComments.json +0 -769
  475. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +0 -683
  476. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +0 -350
  477. package/source/openapi-specifications/v1.0/support/ContactProfile.json +0 -195
  478. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +0 -1157
  479. package/source/openapi-specifications/v1.0/support/Contract.json +0 -2877
  480. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +0 -307
  481. package/source/openapi-specifications/v1.0/support/Conversation.json +0 -570
  482. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +0 -5279
  483. package/source/openapi-specifications/v1.0/support/CreditCycle.json +0 -124
  484. package/source/openapi-specifications/v1.0/support/Criteria.json +0 -1014
  485. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +0 -50
  486. package/source/openapi-specifications/v1.0/support/CrmInteg.json +0 -5938
  487. package/source/openapi-specifications/v1.0/support/CustomAction.json +0 -2106
  488. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +0 -1327
  489. package/source/openapi-specifications/v1.0/support/CustomButton.json +0 -1898
  490. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +0 -883
  491. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +0 -329
  492. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +0 -317
  493. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +0 -379
  494. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +0 -3457
  495. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +0 -81
  496. package/source/openapi-specifications/v1.0/support/CustomTheme.json +0 -7391
  497. package/source/openapi-specifications/v1.0/support/CustomView.json +0 -3478
  498. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +0 -464
  499. package/source/openapi-specifications/v1.0/support/DBThrottle.json +0 -334
  500. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +0 -1163
  501. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +0 -1258
  502. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +0 -2310
  503. package/source/openapi-specifications/v1.0/support/Dashboards.json +0 -1219
  504. package/source/openapi-specifications/v1.0/support/DataChips.json +0 -477
  505. package/source/openapi-specifications/v1.0/support/DataImport.json +0 -1099
  506. package/source/openapi-specifications/v1.0/support/DataSync.json +0 -1246
  507. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +0 -153
  508. package/source/openapi-specifications/v1.0/support/Department.json +0 -1971
  509. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +0 -656
  510. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +0 -232
  511. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +0 -722
  512. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +0 -91
  513. package/source/openapi-specifications/v1.0/support/DomainMapping.json +0 -1143
  514. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +0 -306
  515. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +0 -1491
  516. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +0 -572
  517. package/source/openapi-specifications/v1.0/support/Event.json +0 -3607
  518. package/source/openapi-specifications/v1.0/support/EventComments.json +0 -737
  519. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +0 -1520
  520. package/source/openapi-specifications/v1.0/support/EventTimer.json +0 -285
  521. package/source/openapi-specifications/v1.0/support/Expression.json +0 -43
  522. package/source/openapi-specifications/v1.0/support/Extension.json +0 -7152
  523. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +0 -129
  524. package/source/openapi-specifications/v1.0/support/FAQ.json +0 -142
  525. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +0 -178
  526. package/source/openapi-specifications/v1.0/support/FbManager.json +0 -1147
  527. package/source/openapi-specifications/v1.0/support/Feature.json +0 -691
  528. package/source/openapi-specifications/v1.0/support/FeatureFile.json +0 -435
  529. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +0 -576
  530. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +0 -492
  531. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +0 -318
  532. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +0 -198
  533. package/source/openapi-specifications/v1.0/support/Field.json +0 -7493
  534. package/source/openapi-specifications/v1.0/support/FieldDetails.json +0 -139
  535. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +0 -113
  536. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +0 -3831
  537. package/source/openapi-specifications/v1.0/support/FileExport.json +0 -324
  538. package/source/openapi-specifications/v1.0/support/Finance.json +0 -4290
  539. package/source/openapi-specifications/v1.0/support/Followers.json +0 -875
  540. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +0 -47
  541. package/source/openapi-specifications/v1.0/support/GC_Bots.json +0 -138
  542. package/source/openapi-specifications/v1.0/support/GC_Guide.json +0 -1536
  543. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +0 -58
  544. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +0 -79
  545. package/source/openapi-specifications/v1.0/support/GC_Guides.json +0 -89
  546. package/source/openapi-specifications/v1.0/support/GC_Info.json +0 -208
  547. package/source/openapi-specifications/v1.0/support/GC_Status.json +0 -69
  548. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +0 -79
  549. package/source/openapi-specifications/v1.0/support/GenericAction.json +0 -1888
  550. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +0 -1050
  551. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +0 -1715
  552. package/source/openapi-specifications/v1.0/support/GoogleChat.json +0 -650
  553. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +0 -44
  554. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +0 -900
  555. package/source/openapi-specifications/v1.0/support/Helpcenter.json +0 -1212
  556. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +0 -331
  557. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +0 -1496
  558. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +0 -504
  559. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +0 -208
  560. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +0 -64
  561. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +0 -211
  562. package/source/openapi-specifications/v1.0/support/HolidayList.json +0 -731
  563. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +0 -1091
  564. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +0 -1357
  565. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +0 -169
  566. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +0 -624
  567. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +0 -597
  568. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +0 -841
  569. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +0 -64
  570. package/source/openapi-specifications/v1.0/support/IM_Bot.json +0 -1007
  571. package/source/openapi-specifications/v1.0/support/IM_BotService.json +0 -357
  572. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +0 -323
  573. package/source/openapi-specifications/v1.0/support/IM_Channel.json +0 -2849
  574. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +0 -502
  575. package/source/openapi-specifications/v1.0/support/IM_Contact.json +0 -165
  576. package/source/openapi-specifications/v1.0/support/IM_Efc.json +0 -188
  577. package/source/openapi-specifications/v1.0/support/IM_Integration.json +0 -1269
  578. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +0 -454
  579. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +0 -625
  580. package/source/openapi-specifications/v1.0/support/IM_License.json +0 -225
  581. package/source/openapi-specifications/v1.0/support/IM_Message.json +0 -1371
  582. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +0 -462
  583. package/source/openapi-specifications/v1.0/support/IM_Search.json +0 -547
  584. package/source/openapi-specifications/v1.0/support/IM_Session.json +0 -1397
  585. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +0 -142
  586. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +0 -83
  587. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +0 -86
  588. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +0 -73
  589. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +0 -435
  590. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +0 -202
  591. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +0 -193
  592. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +0 -489
  593. package/source/openapi-specifications/v1.0/support/Import.json +0 -1844
  594. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +0 -395
  595. package/source/openapi-specifications/v1.0/support/Inference.json +0 -307
  596. package/source/openapi-specifications/v1.0/support/InlineImage.json +0 -97
  597. package/source/openapi-specifications/v1.0/support/IntegModule.json +0 -938
  598. package/source/openapi-specifications/v1.0/support/Integrations.json +0 -1264
  599. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +0 -539
  600. package/source/openapi-specifications/v1.0/support/JWT.json +0 -535
  601. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +0 -208
  602. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +0 -241
  603. package/source/openapi-specifications/v1.0/support/KBPreference.json +0 -323
  604. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +0 -2316
  605. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +0 -2839
  606. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +0 -570
  607. package/source/openapi-specifications/v1.0/support/KBSection.json +0 -1941
  608. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +0 -169
  609. package/source/openapi-specifications/v1.0/support/KPIWidget.json +0 -206
  610. package/source/openapi-specifications/v1.0/support/KbBot.json +0 -511
  611. package/source/openapi-specifications/v1.0/support/KbCategory.json +0 -1618
  612. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +0 -124
  613. package/source/openapi-specifications/v1.0/support/Label.json +0 -1251
  614. package/source/openapi-specifications/v1.0/support/Layout.json +0 -8042
  615. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +0 -491
  616. package/source/openapi-specifications/v1.0/support/LayoutRules.json +0 -1422
  617. package/source/openapi-specifications/v1.0/support/LensInteg.json +0 -86
  618. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +0 -548
  619. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +0 -1231
  620. package/source/openapi-specifications/v1.0/support/LicenseTool.json +0 -165
  621. package/source/openapi-specifications/v1.0/support/Livecall.json +0 -954
  622. package/source/openapi-specifications/v1.0/support/LookupRecord.json +0 -174
  623. package/source/openapi-specifications/v1.0/support/Macros.json +0 -1960
  624. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +0 -1263
  625. package/source/openapi-specifications/v1.0/support/MassAction.json +0 -1151
  626. package/source/openapi-specifications/v1.0/support/MassActionError.json +0 -55
  627. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +0 -89
  628. package/source/openapi-specifications/v1.0/support/Mentions.json +0 -491
  629. package/source/openapi-specifications/v1.0/support/Message.json +0 -685
  630. package/source/openapi-specifications/v1.0/support/Microsoft.json +0 -887
  631. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +0 -574
  632. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +0 -903
  633. package/source/openapi-specifications/v1.0/support/Misc.json +0 -214
  634. package/source/openapi-specifications/v1.0/support/Module.json +0 -1625
  635. package/source/openapi-specifications/v1.0/support/NewCriteria.json +0 -1863
  636. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +0 -204
  637. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +0 -150
  638. package/source/openapi-specifications/v1.0/support/NotificationRules.json +0 -441
  639. package/source/openapi-specifications/v1.0/support/OEmbedData.json +0 -233
  640. package/source/openapi-specifications/v1.0/support/Onboarding.json +0 -282
  641. package/source/openapi-specifications/v1.0/support/Organization.json +0 -1391
  642. package/source/openapi-specifications/v1.0/support/PBGroup.json +0 -634
  643. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +0 -433
  644. package/source/openapi-specifications/v1.0/support/PBPlatform.json +0 -1447
  645. package/source/openapi-specifications/v1.0/support/PBX.json +0 -550
  646. package/source/openapi-specifications/v1.0/support/PBXConfig.json +0 -219
  647. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +0 -443
  648. package/source/openapi-specifications/v1.0/support/PBXPreference.json +0 -314
  649. package/source/openapi-specifications/v1.0/support/PageSense.json +0 -1505
  650. package/source/openapi-specifications/v1.0/support/PendingApproval.json +0 -279
  651. package/source/openapi-specifications/v1.0/support/Permalink.json +0 -393
  652. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +0 -1014
  653. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +0 -118
  654. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +0 -1115
  655. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +0 -232
  656. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +0 -499
  657. package/source/openapi-specifications/v1.0/support/Product.json +0 -1861
  658. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +0 -485
  659. package/source/openapi-specifications/v1.0/support/Profile.json +0 -4236
  660. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +0 -989
  661. package/source/openapi-specifications/v1.0/support/QueryStore.json +0 -238
  662. package/source/openapi-specifications/v1.0/support/QueueView.json +0 -335
  663. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +0 -1204
  664. package/source/openapi-specifications/v1.0/support/Records.json +0 -1509
  665. package/source/openapi-specifications/v1.0/support/Recyclebin.json +0 -669
  666. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +0 -401
  667. package/source/openapi-specifications/v1.0/support/Report.json +0 -6491
  668. package/source/openapi-specifications/v1.0/support/ReportChart.json +0 -254
  669. package/source/openapi-specifications/v1.0/support/ReportFolder.json +0 -1076
  670. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +0 -202
  671. package/source/openapi-specifications/v1.0/support/RequestFlags.json +0 -358
  672. package/source/openapi-specifications/v1.0/support/Resources.json +0 -335
  673. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +0 -128
  674. package/source/openapi-specifications/v1.0/support/Role.json +0 -996
  675. package/source/openapi-specifications/v1.0/support/RoundRobin.json +0 -796
  676. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +0 -381
  677. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +0 -615
  678. package/source/openapi-specifications/v1.0/support/RuleGroup.json +0 -1630
  679. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +0 -227
  680. package/source/openapi-specifications/v1.0/support/Saml.json +0 -565
  681. package/source/openapi-specifications/v1.0/support/Sandbox.json +0 -1075
  682. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +0 -501
  683. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +0 -428
  684. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +0 -295
  685. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +0 -268
  686. package/source/openapi-specifications/v1.0/support/SavedFilters.json +0 -652
  687. package/source/openapi-specifications/v1.0/support/Schedule.json +0 -2077
  688. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +0 -2271
  689. package/source/openapi-specifications/v1.0/support/Search.json +0 -12600
  690. package/source/openapi-specifications/v1.0/support/SearchInteg.json +0 -2254
  691. package/source/openapi-specifications/v1.0/support/Setup.json +0 -1766
  692. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +0 -1110
  693. package/source/openapi-specifications/v1.0/support/SharingRule.json +0 -287
  694. package/source/openapi-specifications/v1.0/support/Signature.json +0 -354
  695. package/source/openapi-specifications/v1.0/support/Skill.json +0 -2164
  696. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +0 -269
  697. package/source/openapi-specifications/v1.0/support/SkillType.json +0 -807
  698. package/source/openapi-specifications/v1.0/support/Slack.json +0 -957
  699. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +0 -514
  700. package/source/openapi-specifications/v1.0/support/Snippets.json +0 -918
  701. package/source/openapi-specifications/v1.0/support/SocialBrands.json +0 -427
  702. package/source/openapi-specifications/v1.0/support/SocialInteg.json +0 -336
  703. package/source/openapi-specifications/v1.0/support/SocialPosts.json +0 -2460
  704. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +0 -337
  705. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +0 -690
  706. package/source/openapi-specifications/v1.0/support/Statistics.json +0 -125
  707. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +0 -2419
  708. package/source/openapi-specifications/v1.0/support/Supervise.json +0 -774
  709. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +0 -188
  710. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +0 -293
  711. package/source/openapi-specifications/v1.0/support/SupportPlan.json +0 -1109
  712. package/source/openapi-specifications/v1.0/support/Tab.json +0 -606
  713. package/source/openapi-specifications/v1.0/support/Target.json +0 -1311
  714. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +0 -130
  715. package/source/openapi-specifications/v1.0/support/Task.json +0 -4006
  716. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +0 -443
  717. package/source/openapi-specifications/v1.0/support/TaskComments.json +0 -706
  718. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +0 -1756
  719. package/source/openapi-specifications/v1.0/support/TaskTimer.json +0 -441
  720. package/source/openapi-specifications/v1.0/support/Team.json +0 -1383
  721. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +0 -1069
  722. package/source/openapi-specifications/v1.0/support/Theme.json +0 -152
  723. package/source/openapi-specifications/v1.0/support/Thread.json +0 -3545
  724. package/source/openapi-specifications/v1.0/support/Ticket.json +0 -9495
  725. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +0 -855
  726. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +0 -562
  727. package/source/openapi-specifications/v1.0/support/TicketComment.json +0 -1444
  728. package/source/openapi-specifications/v1.0/support/TicketCount.json +0 -690
  729. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +0 -454
  730. package/source/openapi-specifications/v1.0/support/TicketHistory.json +0 -414
  731. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +0 -369
  732. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +0 -178
  733. package/source/openapi-specifications/v1.0/support/TicketTag.json +0 -1513
  734. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +0 -907
  735. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +0 -1681
  736. package/source/openapi-specifications/v1.0/support/TicketTimer.json +0 -1205
  737. package/source/openapi-specifications/v1.0/support/TimeTracking.json +0 -1212
  738. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +0 -614
  739. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +0 -163
  740. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +0 -2772
  741. package/source/openapi-specifications/v1.0/support/Upload.json +0 -620
  742. package/source/openapi-specifications/v1.0/support/User.json +0 -1409
  743. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +0 -617
  744. package/source/openapi-specifications/v1.0/support/UserPresence.json +0 -763
  745. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +0 -107
  746. package/source/openapi-specifications/v1.0/support/ValidationRules.json +0 -1173
  747. package/source/openapi-specifications/v1.0/support/Webhook.json +0 -1330
  748. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +0 -132
  749. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +0 -143
  750. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +0 -132
  751. package/source/openapi-specifications/v1.0/support/Widget.json +0 -3023
  752. package/source/openapi-specifications/v1.0/support/WmsDomain.json +0 -104
  753. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +0 -756
  754. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +0 -989
  755. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +0 -135
  756. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +0 -376
  757. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +0 -159
  758. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +0 -3229
  759. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +0 -453
  760. package/source/openapi-specifications/v1.0/support/Zwitch.json +0 -1543
  761. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +0 -201
  762. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +0 -75
  763. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +0 -255
  764. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +0 -1677
  765. package/source/openapi-specifications/v1.0/support/blueprintStates.json +0 -284
  766. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +0 -91
  767. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +0 -1546
  768. package/source/openapi-specifications/v1.0/support/blueprints.json +0 -2992
  769. package/source/openapi-specifications/v1.0/support/errors.json +0 -80
  770. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +0 -416
@@ -1,3053 +0,0 @@
1
- {
2
- "openapi" : "3.1.0",
3
- "info" : {
4
- "title" : "ArticleStatistics",
5
- "version" : "1.0.0",
6
- "x-clan-group" : "helpCenter",
7
- "x-module-group" : "kb"
8
- },
9
- "paths" : {
10
- "/api/v1/articleDashboard/statistics" : {
11
- "get" : {
12
- "tags" : [ "ArticleStatistics" ],
13
- "summary" : "Get article statistics",
14
- "description" : "This API fetches the statistics related to help articles in your Knowledge Base.",
15
- "operationId" : "getArticleDashboardStatistics",
16
- "parameters" : [ {
17
- "$ref" : "#/components/parameters/rootCategoryIds"
18
- }, {
19
- "name" : "statsType",
20
- "in" : "query",
21
- "description" : "Type of statistical data that must be fetched. Values allowed are: ARTICLES_REFERENCED, VOTED_PORTAL_USERS, CREATED_ARTICLES and MODIFIED_ARTICLES",
22
- "required" : false,
23
- "style" : "form",
24
- "explode" : true,
25
- "schema" : {
26
- "type" : [ "string", "null" ],
27
- "description" : "Type of statistical data that must be fetched. Values allowed are: ARTICLES_REFERENCED, VOTED_PORTAL_USERS, CREATED_ARTICLES and MODIFIED_ARTICLES",
28
- "enum" : [ "ARTICLES_REFERENCED", "VOTED_PORTAL_USERS", "CREATED_ARTICLES", "MODIFIED_ARTICLES" ],
29
- "maxLength" : 100,
30
- "minLength" : 0,
31
- "x-custom-parameters-attributes" : {
32
- "split" : ","
33
- }
34
- }
35
- }, {
36
- "$ref" : "#/components/parameters/departmentIds"
37
- }, {
38
- "$ref" : "#/components/parameters/locale"
39
- }, {
40
- "$ref" : "#/components/parameters/timeRange"
41
- }, {
42
- "$ref" : "../common/Common.json#/components/parameters/orgId"
43
- } ],
44
- "responses" : {
45
- "422" : {
46
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
47
- },
48
- "200" : {
49
- "$ref" : "#/components/responses/kbDashboardStatisticsResponse"
50
- }
51
- },
52
- "security" : [ {
53
- "org-oauth" : [ "accessAll.ALL" ]
54
- }, {
55
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
56
- } ],
57
- "x-audience" : [ "company-internal" ],
58
- "x-custom-url-attribute" : {
59
- "security" : {
60
- "throttle" : {
61
- "inline" : [ {
62
- "scope" : "APPSERVER",
63
- "rules" : [ {
64
- "duration" : 60000,
65
- "lock-period" : 600000,
66
- "threshold" : 50,
67
- "hip" : false
68
- }, {
69
- "duration" : 3600000,
70
- "lock-period" : 1800000,
71
- "threshold" : 300,
72
- "hip" : false
73
- } ],
74
- "window" : "ROLLING",
75
- "key" : "url.path+user.zuid"
76
- } ]
77
- },
78
- "extraparams" : {
79
- "disable" : true,
80
- "ignore" : false
81
- },
82
- "authentication" : { }
83
- },
84
- "clan-group" : "helpCenter",
85
- "apihash" : "163f3dac9c452d6d7784684afa3c4b02",
86
- "module-group" : "kb",
87
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getKBDashboardStatistics"
88
- }
89
- }
90
- },
91
- "/api/v1/articles/trends" : {
92
- "get" : {
93
- "tags" : [ "ArticleStatistics" ],
94
- "summary" : "Get data related to trend of Knowledge Base",
95
- "description" : "This API fetches data related to the overall trend of user actions recorded in your Knowledge Base.",
96
- "operationId" : "getKBTrends",
97
- "parameters" : [ {
98
- "$ref" : "#/components/parameters/rootCategoryIds"
99
- }, {
100
- "$ref" : "#/components/parameters/limit"
101
- }, {
102
- "$ref" : "#/components/parameters/action"
103
- }, {
104
- "name" : "permission",
105
- "in" : "query",
106
- "description" : "User visibility permission set for the translation. Values allowed are: !@ALL,@! !@REGISTEREDUSERS@! and !@AGENTS@!.",
107
- "required" : false,
108
- "style" : "simple",
109
- "explode" : true,
110
- "schema" : {
111
- "type" : [ "string", "null" ],
112
- "description" : "User visibility permission set for the translation. Values allowed are: !@ALL,@! !@REGISTEREDUSERS@! and !@AGENTS@!.",
113
- "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ],
114
- "maxLength" : 100,
115
- "minLength" : 0,
116
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User visibility permission set for the translation. Values allowed are: !@ALL,@! !@REGISTEREDUSERS@! and !@AGENTS@!.", false, 10, ",", false, false, "0,5", false, false ]
117
- }
118
- }, {
119
- "$ref" : "#/components/parameters/from"
120
- }, {
121
- "$ref" : "#/components/parameters/departmentIds"
122
- }, {
123
- "$ref" : "#/components/parameters/userType"
124
- }, {
125
- "$ref" : "#/components/parameters/locale"
126
- }, {
127
- "$ref" : "#/components/parameters/helpcenterIds"
128
- }, {
129
- "$ref" : "#/components/parameters/timeRange"
130
- }, {
131
- "$ref" : "#/components/parameters/actionSource"
132
- }, {
133
- "name" : "status",
134
- "in" : "query",
135
- "description" : "Publishing status of the translation. Values allowed are: Draft, Published, Review, Expired and Unpublished.",
136
- "required" : false,
137
- "style" : "simple",
138
- "explode" : true,
139
- "schema" : {
140
- "type" : [ "null", "array" ],
141
- "description" : "Publishing status of the translation. Values allowed are: Draft, Published, Review, Expired and Unpublished.",
142
- "items" : {
143
- "type" : [ "string", "null" ],
144
- "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ],
145
- "maxLength" : 100,
146
- "minLength" : 0,
147
- "x-custom-parameters-attributes" : [ ]
148
- },
149
- "maxItems" : 4,
150
- "minItems" : 0,
151
- "uniqueItems" : false
152
- }
153
- }, {
154
- "$ref" : "../common/Common.json#/components/parameters/orgId"
155
- } ],
156
- "responses" : {
157
- "422" : {
158
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
159
- },
160
- "200" : {
161
- "$ref" : "#/components/responses/articleTrendResponse"
162
- }
163
- },
164
- "security" : [ {
165
- "org-oauth" : [ "accessAll.ALL" ]
166
- }, {
167
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
168
- } ],
169
- "x-audience" : [ "company-internal" ],
170
- "x-custom-url-attribute" : {
171
- "security" : {
172
- "throttle" : {
173
- "policy" : "ReadAPI_Standard_UserPolicy"
174
- },
175
- "extraparams" : {
176
- "disable" : true,
177
- "ignore" : false
178
- },
179
- "authentication" : { }
180
- },
181
- "clan-group" : "helpCenter",
182
- "apihash" : "229372f64a186c9a53160075827971b8",
183
- "module-group" : "kb",
184
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getKBTrends"
185
- }
186
- }
187
- },
188
- "/api/v1/articles/{articleId}/translations/{locale}/insights/reset" : {
189
- "post" : {
190
- "tags" : [ "ArticleStatistics" ],
191
- "summary" : "Reset metrics of a translation in the article",
192
- "description" : "This API resets the metrics on a translated version of an article.",
193
- "operationId" : "resetArticleTranslationMetrics",
194
- "parameters" : [ {
195
- "$ref" : "#/components/parameters/articleId"
196
- }, {
197
- "$ref" : "#/components/parameters/locale"
198
- }, {
199
- "$ref" : "../common/Common.json#/components/parameters/orgId"
200
- } ],
201
- "requestBody" : {
202
- "$ref" : "#/components/requestBodies/metricsResetPayload"
203
- },
204
- "responses" : {
205
- "422" : {
206
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
207
- },
208
- "204" : {
209
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
210
- }
211
- },
212
- "security" : [ {
213
- "org-oauth" : [ "accessAll.ALL" ]
214
- }, {
215
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
216
- } ],
217
- "x-audience" : [ "company-internal" ],
218
- "x-custom-url-attribute" : {
219
- "security" : {
220
- "throttle" : {
221
- "inline" : [ {
222
- "scope" : "APPSERVER",
223
- "rules" : [ {
224
- "duration" : 60000,
225
- "lock-period" : 600000,
226
- "threshold" : 5,
227
- "hip" : false
228
- }, {
229
- "duration" : 3600000,
230
- "lock-period" : 1800000,
231
- "threshold" : 20,
232
- "hip" : false
233
- }, {
234
- "duration" : 86400000,
235
- "lock-period" : 3600000,
236
- "threshold" : 80,
237
- "hip" : false
238
- } ],
239
- "window" : "ROLLING",
240
- "key" : "url.path+user.zuid"
241
- } ]
242
- },
243
- "extraparams" : {
244
- "disable" : true,
245
- "ignore" : false
246
- },
247
- "authentication" : { }
248
- },
249
- "clan-group" : "helpCenter",
250
- "apihash" : "857e1400f15e7c79f0ac8f25e484b10c",
251
- "module-group" : "kb",
252
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.resetTranslationMetrics"
253
- }
254
- }
255
- },
256
- "/api/v1/articles/{articleId}/insights/reset" : {
257
- "post" : {
258
- "tags" : [ "ArticleStatistics" ],
259
- "summary" : "Reset metrics of all translations in the article",
260
- "description" : "This API resets the metrics on all translated versions of an article.",
261
- "operationId" : "resetArticleMetrics",
262
- "parameters" : [ {
263
- "$ref" : "#/components/parameters/articleId"
264
- }, {
265
- "$ref" : "../common/Common.json#/components/parameters/orgId"
266
- } ],
267
- "requestBody" : {
268
- "$ref" : "#/components/requestBodies/resetArticleMetrics_metricsResetPayload"
269
- },
270
- "responses" : {
271
- "422" : {
272
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
273
- },
274
- "204" : {
275
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
276
- }
277
- },
278
- "security" : [ {
279
- "org-oauth" : [ "accessAll.ALL" ]
280
- }, {
281
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
282
- } ],
283
- "x-audience" : [ "company-internal" ],
284
- "x-custom-url-attribute" : {
285
- "security" : {
286
- "throttle" : {
287
- "inline" : [ {
288
- "scope" : "APPSERVER",
289
- "rules" : [ {
290
- "duration" : 60000,
291
- "lock-period" : 600000,
292
- "threshold" : 5,
293
- "hip" : false
294
- }, {
295
- "duration" : 3600000,
296
- "lock-period" : 1800000,
297
- "threshold" : 20,
298
- "hip" : false
299
- }, {
300
- "duration" : 86400000,
301
- "lock-period" : 3600000,
302
- "threshold" : 80,
303
- "hip" : false
304
- } ],
305
- "window" : "ROLLING",
306
- "key" : "url.path+user.zuid"
307
- } ]
308
- },
309
- "extraparams" : {
310
- "disable" : true,
311
- "ignore" : false
312
- },
313
- "authentication" : { }
314
- },
315
- "clan-group" : "helpCenter",
316
- "apihash" : "8cf22dc1920349c2ee0ed0c089b821a9",
317
- "module-group" : "kb",
318
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.resetArticleMetrics"
319
- }
320
- }
321
- },
322
- "/api/v1/articles/{articleId}/translations/{locale}/trends" : {
323
- "get" : {
324
- "tags" : [ "ArticleStatistics" ],
325
- "summary" : "Get data related to translation trend",
326
- "description" : "This API fetches data related to the trend of user actions recorded on a particular translation of a help article.",
327
- "operationId" : "getArticleTranslationTrends",
328
- "parameters" : [ {
329
- "$ref" : "#/components/parameters/limit"
330
- }, {
331
- "$ref" : "#/components/parameters/action"
332
- }, {
333
- "$ref" : "#/components/parameters/from"
334
- }, {
335
- "$ref" : "#/components/parameters/userType"
336
- }, {
337
- "$ref" : "#/components/parameters/timeRange"
338
- }, {
339
- "$ref" : "#/components/parameters/actionSource"
340
- }, {
341
- "$ref" : "#/components/parameters/articleId"
342
- }, {
343
- "$ref" : "#/components/parameters/locale"
344
- }, {
345
- "$ref" : "../common/Common.json#/components/parameters/orgId"
346
- } ],
347
- "responses" : {
348
- "422" : {
349
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
350
- },
351
- "200" : {
352
- "$ref" : "#/components/responses/articleTrendResponse"
353
- }
354
- },
355
- "security" : [ {
356
- "org-oauth" : [ "accessAll.ALL" ]
357
- }, {
358
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
359
- } ],
360
- "x-audience" : [ "company-internal" ],
361
- "x-custom-url-attribute" : {
362
- "security" : {
363
- "throttle" : {
364
- "policy" : "ReadAPI_Stringent_UserPolicy"
365
- },
366
- "extraparams" : {
367
- "disable" : true,
368
- "ignore" : false
369
- },
370
- "authentication" : { }
371
- },
372
- "clan-group" : "helpCenter",
373
- "apihash" : "e21f9da94f57dbb78e8245490ab7a3f1",
374
- "module-group" : "kb",
375
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getArticleTranslationTrends"
376
- }
377
- }
378
- },
379
- "/api/v1/articles/searchKeywords" : {
380
- "get" : {
381
- "tags" : [ "ArticleStatistics" ],
382
- "summary" : "Get keyword metrics",
383
- "description" : "This API fetches statistics related to keywords used for finding help articles.",
384
- "operationId" : "getSearchKeywords",
385
- "parameters" : [ {
386
- "name" : "duration",
387
- "in" : "query",
388
- "description" : " Duration about to get the search keywords stats. Allowed Values LAST_24_HRS, LAST_7_DAYS, LAST_30_DAYS, LAST_365_DAYS and yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ. Default value : !@LAST_365_DAYS@!",
389
- "required" : false,
390
- "style" : "form",
391
- "explode" : true,
392
- "schema" : {
393
- "type" : [ "string", "null" ],
394
- "description" : " Duration about to get the search keywords stats. Allowed Values LAST_24_HRS, LAST_7_DAYS, LAST_30_DAYS, LAST_365_DAYS and yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ. Default value : !@LAST_365_DAYS@!",
395
- "enum" : [ "weekly", "monthly", "yearly" ],
396
- "maxLength" : 100,
397
- "minLength" : 0
398
- }
399
- }, {
400
- "name" : "departmentId",
401
- "in" : "query",
402
- "description" : "Department to get the search keywords count. If departmentId is not given, it considered as all department",
403
- "required" : false,
404
- "style" : "form",
405
- "explode" : true,
406
- "schema" : {
407
- "type" : [ "string", "null", "integer" ],
408
- "format" : "int64",
409
- "description" : "Department to get the search keywords count. If departmentId is not given, it considered as all department",
410
- "pattern" : "([0-9]+)"
411
- }
412
- }, {
413
- "$ref" : "#/components/parameters/limit"
414
- }, {
415
- "name" : "searchMetricsType",
416
- "in" : "query",
417
- "description" : "Search metrics type. If not given, it will return both failure and popular keywords. Allowed Values !@SUCCESS,@! !@FAILURE@!",
418
- "required" : false,
419
- "style" : "simple",
420
- "explode" : true,
421
- "schema" : {
422
- "type" : [ "null", "array" ],
423
- "description" : "Search metrics type. If not given, it will return both failure and popular keywords. Allowed Values !@SUCCESS,@! !@FAILURE@!",
424
- "items" : {
425
- "type" : [ "string", "null" ],
426
- "enum" : [ "SUCCESS", "FAILURE" ],
427
- "maxLength" : 100,
428
- "minLength" : 0,
429
- "x-custom-parameters-attributes" : [ ]
430
- },
431
- "maxItems" : 2,
432
- "minItems" : 1,
433
- "uniqueItems" : true
434
- }
435
- }, {
436
- "$ref" : "../common/Common.json#/components/parameters/orgId"
437
- } ],
438
- "responses" : {
439
- "422" : {
440
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
441
- },
442
- "200" : {
443
- "$ref" : "#/components/responses/getSearchKeywordsResponse"
444
- }
445
- },
446
- "security" : [ {
447
- "org-oauth" : [ "accessAll.ALL" ]
448
- }, {
449
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
450
- } ],
451
- "x-audience" : [ "company-internal" ],
452
- "x-custom-url-attribute" : {
453
- "security" : {
454
- "throttle" : {
455
- "policy" : "ReadAPI_Stringent_UserPolicy"
456
- },
457
- "extraparams" : {
458
- "disable" : true,
459
- "ignore" : false
460
- },
461
- "authentication" : { }
462
- },
463
- "clan-group" : "helpCenter",
464
- "apihash" : "dd134cfc0d9c01761411f40dba32d894",
465
- "module-group" : "kb",
466
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getArticleSearchKeywords"
467
- }
468
- }
469
- },
470
- "/api/v1/articles/interactedUsers" : {
471
- "get" : {
472
- "tags" : [ "ArticleStatistics" ],
473
- "summary" : "List users who interacted with your Knowledge Base",
474
- "description" : "This API lists a particular number of users who interacted with multiple help articles, based on the limit specified.",
475
- "operationId" : "getKBInteractedUsers",
476
- "parameters" : [ {
477
- "name" : "limit",
478
- "in" : "query",
479
- "description" : "Number of users to list. The default value is 10 and the maximum value allowed is 100.",
480
- "required" : false,
481
- "style" : "form",
482
- "explode" : true,
483
- "schema" : {
484
- "type" : [ "string", "null", "integer" ],
485
- "format" : "int32",
486
- "description" : "Number of users to list. The default value is 10 and the maximum value allowed is 100.",
487
- "maximum" : 100,
488
- "minimum" : 1,
489
- "pattern" : "([0-9]+)"
490
- }
491
- }, {
492
- "name" : "action",
493
- "in" : "query",
494
- "description" : "Action that the users performed. Values allowed are !@LIKE@! and !@DISLIKE@!. default value is !@LIKE@!",
495
- "required" : true,
496
- "style" : "simple",
497
- "explode" : true,
498
- "schema" : {
499
- "type" : [ "string", "null" ],
500
- "description" : "Action that the users performed. Values allowed are !@LIKE@! and !@DISLIKE@!. default value is !@LIKE@!",
501
- "enum" : [ "LIKE", "DISLIKE" ],
502
- "maxLength" : 100,
503
- "minLength" : 0,
504
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.", false, 10, ",", false, false, "0,5", false, false ]
505
- }
506
- }, {
507
- "name" : "userType",
508
- "in" : "query",
509
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
510
- "required" : false,
511
- "style" : "form",
512
- "explode" : true,
513
- "schema" : {
514
- "type" : [ "string", "null" ],
515
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
516
- "enum" : [ "AGENTS", "REGISTERED_USERS", "ALL_USERS" ],
517
- "maxLength" : 100,
518
- "minLength" : 0
519
- }
520
- }, {
521
- "$ref" : "#/components/parameters/rootCategoryIds"
522
- }, {
523
- "$ref" : "#/components/parameters/from"
524
- }, {
525
- "$ref" : "#/components/parameters/departmentIds"
526
- }, {
527
- "$ref" : "#/components/parameters/locale"
528
- }, {
529
- "$ref" : "#/components/parameters/helpcenterIds"
530
- }, {
531
- "$ref" : "#/components/parameters/timeRange"
532
- }, {
533
- "$ref" : "../common/Common.json#/components/parameters/orgId"
534
- } ],
535
- "responses" : {
536
- "422" : {
537
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
538
- },
539
- "200" : {
540
- "$ref" : "#/components/responses/interactedUsersResponse"
541
- }
542
- },
543
- "security" : [ {
544
- "org-oauth" : [ "accessAll.ALL" ]
545
- }, {
546
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
547
- } ],
548
- "x-audience" : [ "company-internal" ],
549
- "x-custom-url-attribute" : {
550
- "security" : {
551
- "throttle" : {
552
- "policy" : "ReadAPI_Standard_UserPolicy"
553
- },
554
- "extraparams" : {
555
- "disable" : true,
556
- "ignore" : false
557
- },
558
- "authentication" : { }
559
- },
560
- "clan-group" : "helpCenter",
561
- "apihash" : "597988efab2e4bef8528cddcb84abbd7",
562
- "module-group" : "kb",
563
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getKBIntercatedUsers"
564
- }
565
- }
566
- },
567
- "/api/v1/articles/{articleId}/trends" : {
568
- "get" : {
569
- "tags" : [ "ArticleStatistics" ],
570
- "summary" : "Get data related to article trend",
571
- "description" : "This API fetches data related to the trend of user actions recorded on a help article and all of its translations.",
572
- "operationId" : "getArticleTrends",
573
- "parameters" : [ {
574
- "$ref" : "#/components/parameters/limit"
575
- }, {
576
- "$ref" : "#/components/parameters/action"
577
- }, {
578
- "$ref" : "#/components/parameters/from"
579
- }, {
580
- "$ref" : "#/components/parameters/userType"
581
- }, {
582
- "$ref" : "#/components/parameters/timeRange"
583
- }, {
584
- "$ref" : "#/components/parameters/actionSource"
585
- }, {
586
- "$ref" : "#/components/parameters/articleId"
587
- }, {
588
- "$ref" : "../common/Common.json#/components/parameters/orgId"
589
- } ],
590
- "responses" : {
591
- "422" : {
592
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
593
- },
594
- "200" : {
595
- "$ref" : "#/components/responses/articleTrendResponse"
596
- }
597
- },
598
- "security" : [ {
599
- "org-oauth" : [ "accessAll.ALL" ]
600
- }, {
601
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
602
- } ],
603
- "x-audience" : [ "company-internal" ],
604
- "x-custom-url-attribute" : {
605
- "security" : {
606
- "throttle" : {
607
- "policy" : "ReadAPI_Stringent_UserPolicy"
608
- },
609
- "extraparams" : {
610
- "disable" : true,
611
- "ignore" : false
612
- },
613
- "authentication" : { }
614
- },
615
- "clan-group" : "helpCenter",
616
- "apihash" : "a82bb972c2cd538da5389ec2505a8393",
617
- "module-group" : "kb",
618
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getArticleTrends"
619
- }
620
- }
621
- },
622
- "/api/v1/articleDashboard/reports/generate" : {
623
- "post" : {
624
- "tags" : [ "ArticleStatistics" ],
625
- "summary" : "Generate real-time report of top articles",
626
- "description" : "This API generates a real-time report of help articles that received the most number of user actions.",
627
- "operationId" : "generateTopArticleReport",
628
- "parameters" : [ {
629
- "$ref" : "../common/Common.json#/components/parameters/orgId"
630
- } ],
631
- "requestBody" : {
632
- "$ref" : "#/components/requestBodies/reportGenerationPayload"
633
- },
634
- "responses" : {
635
- "422" : {
636
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
637
- },
638
- "204" : {
639
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
640
- }
641
- },
642
- "security" : [ {
643
- "org-oauth" : [ "accessAll.ALL" ]
644
- }, {
645
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
646
- } ],
647
- "x-audience" : [ "company-internal" ],
648
- "x-custom-url-attribute" : {
649
- "security" : {
650
- "throttle" : {
651
- "inline" : [ {
652
- "scope" : "APPSERVER",
653
- "rules" : [ {
654
- "duration" : 60000,
655
- "lock-period" : 600000,
656
- "threshold" : 50,
657
- "hip" : false
658
- }, {
659
- "duration" : 3600000,
660
- "lock-period" : 1800000,
661
- "threshold" : 300,
662
- "hip" : false
663
- } ],
664
- "window" : "ROLLING",
665
- "key" : "url.path+user.zuid"
666
- } ]
667
- },
668
- "extraparams" : {
669
- "disable" : true,
670
- "ignore" : false
671
- },
672
- "authentication" : { }
673
- },
674
- "clan-group" : "helpCenter",
675
- "apihash" : "e25ec46d50f42d4481a56a899e552659",
676
- "module-group" : "kb",
677
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.generateTopArticleEntities"
678
- }
679
- }
680
- },
681
- "/api/v1/articles/{articleId}/insights/flush" : {
682
- "post" : {
683
- "tags" : [ "ArticleStatistics" ],
684
- "summary" : "Update metrics of all translations in the article",
685
- "description" : "This API updates the metrics on all translated versions of an article.",
686
- "operationId" : "updateArticleMetrics",
687
- "parameters" : [ {
688
- "$ref" : "#/components/parameters/articleId"
689
- }, {
690
- "$ref" : "../common/Common.json#/components/parameters/orgId"
691
- } ],
692
- "requestBody" : {
693
- "$ref" : "#/components/requestBodies/metricsUpdatePayload"
694
- },
695
- "responses" : {
696
- "422" : {
697
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
698
- },
699
- "204" : {
700
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
701
- }
702
- },
703
- "security" : [ {
704
- "org-oauth" : [ "accessAll.ALL" ]
705
- }, {
706
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
707
- } ],
708
- "x-audience" : [ "company-internal" ],
709
- "x-custom-url-attribute" : {
710
- "security" : {
711
- "throttle" : {
712
- "inline" : [ {
713
- "scope" : "APPSERVER",
714
- "rules" : [ {
715
- "duration" : 60000,
716
- "lock-period" : 600000,
717
- "threshold" : 5,
718
- "hip" : false
719
- }, {
720
- "duration" : 3600000,
721
- "lock-period" : 1800000,
722
- "threshold" : 30,
723
- "hip" : false
724
- }, {
725
- "duration" : 86400000,
726
- "lock-period" : 3600000,
727
- "threshold" : 100,
728
- "hip" : false
729
- } ],
730
- "window" : "ROLLING",
731
- "key" : "url.path+user.zuid"
732
- } ]
733
- },
734
- "extraparams" : {
735
- "disable" : true,
736
- "ignore" : false
737
- },
738
- "authentication" : { }
739
- },
740
- "clan-group" : "helpCenter",
741
- "apihash" : "52162497a29a0e73b8b2126058c595c2",
742
- "module-group" : "kb",
743
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.flushArticleMetricsCount"
744
- }
745
- }
746
- },
747
- "/api/v1/articleDashboard/reports" : {
748
- "get" : {
749
- "tags" : [ "ArticleStatistics" ],
750
- "summary" : "List top translations",
751
- "description" : "This API lists a particular number of top article translations matching a particular criteria, based on the limit specified.",
752
- "operationId" : "getTopArticleReport",
753
- "parameters" : [ {
754
- "name" : "includeActionCounts",
755
- "in" : "query",
756
- "description" : "Additional information related to the action. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!",
757
- "required" : false,
758
- "style" : "simple",
759
- "explode" : true,
760
- "schema" : {
761
- "type" : [ "null", "array" ],
762
- "description" : "Additional information related to the action. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!",
763
- "items" : {
764
- "type" : [ "string", "null" ],
765
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "TEMPLATE_USAGE", "FEEDBACK" ],
766
- "maxLength" : 100,
767
- "minLength" : 0,
768
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "Additional information related to the action. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@TEMPLATE_USAGE,@! !@COMMENT@! and !@FEEDBACK@!", false, 10, ",", false, false, "0,5", false, false ]
769
- },
770
- "maxItems" : 5,
771
- "uniqueItems" : false
772
- }
773
- }, {
774
- "name" : "limit",
775
- "in" : "query",
776
- "description" : "Number of translations to list. The default value is 10 and the maximum value allowed is 50.",
777
- "required" : false,
778
- "style" : "form",
779
- "explode" : true,
780
- "schema" : {
781
- "type" : [ "string", "null", "integer" ],
782
- "format" : "int32",
783
- "description" : "Number of translations to list. The default value is 10 and the maximum value allowed is 50.",
784
- "maximum" : 50,
785
- "minimum" : 1,
786
- "pattern" : "([0-9]+)"
787
- }
788
- }, {
789
- "name" : "action",
790
- "in" : "query",
791
- "description" : "User action that serves as the condition to apply. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!",
792
- "required" : true,
793
- "style" : "simple",
794
- "explode" : true,
795
- "schema" : {
796
- "type" : [ "string", "null" ],
797
- "description" : "User action that serves as the condition to apply. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!",
798
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "TEMPLATE_USAGE", "FEEDBACK" ],
799
- "maxLength" : 100,
800
- "minLength" : 0,
801
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@TEMPLATE_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.", false, 10, ",", false, false, "0,5", false, false ]
802
- }
803
- }, {
804
- "$ref" : "#/components/parameters/rootCategoryIds"
805
- }, {
806
- "$ref" : "#/components/parameters/from"
807
- }, {
808
- "$ref" : "#/components/parameters/departmentIds"
809
- }, {
810
- "$ref" : "#/components/parameters/locale"
811
- }, {
812
- "$ref" : "#/components/parameters/timeRange"
813
- }, {
814
- "$ref" : "../common/Common.json#/components/parameters/orgId"
815
- } ],
816
- "responses" : {
817
- "422" : {
818
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
819
- },
820
- "200" : {
821
- "$ref" : "#/components/responses/topArticleReportResponse"
822
- }
823
- },
824
- "security" : [ {
825
- "org-oauth" : [ "accessAll.ALL" ]
826
- }, {
827
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
828
- } ],
829
- "x-audience" : [ "company-internal" ],
830
- "x-custom-url-attribute" : {
831
- "security" : {
832
- "throttle" : {
833
- "inline" : [ {
834
- "scope" : "APPSERVER",
835
- "rules" : [ {
836
- "duration" : 60000,
837
- "lock-period" : 600000,
838
- "threshold" : 50,
839
- "hip" : false
840
- }, {
841
- "duration" : 3600000,
842
- "lock-period" : 1800000,
843
- "threshold" : 300,
844
- "hip" : false
845
- } ],
846
- "window" : "ROLLING",
847
- "key" : "url.path+user.zuid"
848
- } ]
849
- },
850
- "extraparams" : {
851
- "disable" : true,
852
- "ignore" : false
853
- },
854
- "authentication" : { }
855
- },
856
- "clan-group" : "helpCenter",
857
- "apihash" : "0934f789c1bd429814523ee2699567cb",
858
- "module-group" : "kb",
859
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.fetchTopArticleReport"
860
- }
861
- }
862
- },
863
- "/api/v1/articleInsights/interactedUsers" : {
864
- "get" : {
865
- "tags" : [ "ArticleStatistics" ],
866
- "summary" : "Get Recent Insights Interacted users of a translation",
867
- "description" : "This API gets article translation insights interacted users based on the filters",
868
- "operationId" : "getInsightsInteractedUsers",
869
- "parameters" : [ {
870
- "name" : "articleId",
871
- "in" : "query",
872
- "description" : "id of an article to which interacted users need to be fetched",
873
- "required" : true,
874
- "style" : "form",
875
- "explode" : true,
876
- "schema" : {
877
- "type" : [ "string", "null", "integer" ],
878
- "format" : "int64",
879
- "description" : "id of an article to which interacted users need to be fetched",
880
- "pattern" : "([0-9]+)"
881
- }
882
- }, {
883
- "name" : "action",
884
- "in" : "query",
885
- "description" : "Action that the users performed. Values allowed are !@LIKE@!,!@DISLIKE@!.,!@VIEW@!. default value is !@VIEW@!",
886
- "required" : false,
887
- "style" : "simple",
888
- "explode" : true,
889
- "schema" : {
890
- "type" : [ "string", "null" ],
891
- "description" : "Action that the users performed. Values allowed are !@LIKE@!,!@DISLIKE@!.,!@VIEW@!. default value is !@VIEW@!",
892
- "enum" : [ "LIKE", "DISLIKE", "VIEW" ],
893
- "maxLength" : 100,
894
- "minLength" : 0,
895
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.", false, 10, ",", false, false, "0,5", false, false ]
896
- }
897
- }, {
898
- "name" : "locale",
899
- "in" : "query",
900
- "description" : "language of the article translation to be fetched",
901
- "required" : true,
902
- "style" : "form",
903
- "explode" : true,
904
- "schema" : {
905
- "type" : [ "string", "null" ],
906
- "description" : "language of the article translation to be fetched",
907
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
908
- "maxLength" : 100,
909
- "minLength" : 0,
910
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
911
- }
912
- }, {
913
- "name" : "limit",
914
- "in" : "query",
915
- "description" : "Number of users to list. The default value is 100 and the maximum value allowed is 100.",
916
- "required" : false,
917
- "style" : "form",
918
- "explode" : true,
919
- "schema" : {
920
- "type" : [ "string", "null", "integer" ],
921
- "format" : "int32",
922
- "description" : "Number of users to list. The default value is 100 and the maximum value allowed is 100.",
923
- "maximum" : 100,
924
- "minimum" : 1,
925
- "pattern" : "([0-9]+)"
926
- }
927
- }, {
928
- "name" : "userType",
929
- "in" : "query",
930
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
931
- "required" : false,
932
- "style" : "form",
933
- "explode" : true,
934
- "schema" : {
935
- "type" : [ "string", "null" ],
936
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
937
- "enum" : [ "AGENTS", "REGISTERED_USERS", "ALL_USERS" ],
938
- "maxLength" : 100,
939
- "minLength" : 0
940
- }
941
- }, {
942
- "$ref" : "#/components/parameters/from"
943
- }, {
944
- "$ref" : "#/components/parameters/timeRange"
945
- }, {
946
- "$ref" : "#/components/parameters/actionSource"
947
- }, {
948
- "$ref" : "../common/Common.json#/components/parameters/orgId"
949
- } ],
950
- "responses" : {
951
- "422" : {
952
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
953
- },
954
- "200" : {
955
- "$ref" : "#/components/responses/interactedUsersResponse"
956
- }
957
- },
958
- "security" : [ {
959
- "org-oauth" : [ "accessAll.ALL" ]
960
- }, {
961
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
962
- } ],
963
- "x-audience" : [ "company-internal" ],
964
- "x-custom-url-attribute" : {
965
- "security" : {
966
- "throttle" : {
967
- "policy" : "ReadAPI_Stringent_UserPolicy"
968
- },
969
- "extraparams" : {
970
- "disable" : true,
971
- "ignore" : false
972
- },
973
- "authentication" : { }
974
- },
975
- "clan-group" : "helpCenter",
976
- "apihash" : "3f86fdc726587e2ebedfc7324cfad4ce",
977
- "module-group" : "kb",
978
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getRecentArticleInteractedUsers"
979
- }
980
- }
981
- },
982
- "/api/v1/articles/{articleId}/translations/{locale}/interactedUsers" : {
983
- "get" : {
984
- "tags" : [ "ArticleStatistics" ],
985
- "summary" : "Get Interacted users of a translation",
986
- "description" : "This API lists the users who interacted with a particular translation of a help article, based on the limit specified.",
987
- "operationId" : "getArticleTranslationInteractedUsers",
988
- "parameters" : [ {
989
- "name" : "locale",
990
- "in" : "path",
991
- "required" : true,
992
- "style" : "simple",
993
- "explode" : false,
994
- "schema" : {
995
- "type" : [ "string", "null" ],
996
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
997
- "maxLength" : 100,
998
- "minLength" : 0,
999
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1000
- }
1001
- }, {
1002
- "name" : "limit",
1003
- "in" : "query",
1004
- "description" : "Number of users to list. The default value is 10 and the maximum value allowed is 100.",
1005
- "required" : false,
1006
- "style" : "form",
1007
- "explode" : true,
1008
- "schema" : {
1009
- "type" : [ "string", "null", "integer" ],
1010
- "format" : "int32",
1011
- "description" : "Number of users to list. The default value is 10 and the maximum value allowed is 100.",
1012
- "maximum" : 100,
1013
- "minimum" : 1,
1014
- "pattern" : "([0-9]+)"
1015
- }
1016
- }, {
1017
- "name" : "action",
1018
- "in" : "query",
1019
- "description" : "Action that the users performed. Values allowed are !@LIKE@! and !@DISLIKE@!. default value is !@LIKE@!",
1020
- "required" : false,
1021
- "style" : "simple",
1022
- "explode" : true,
1023
- "schema" : {
1024
- "type" : [ "string", "null" ],
1025
- "description" : "Action that the users performed. Values allowed are !@LIKE@! and !@DISLIKE@!. default value is !@LIKE@!",
1026
- "enum" : [ "LIKE", "DISLIKE" ],
1027
- "maxLength" : 100,
1028
- "minLength" : 0,
1029
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.", false, 10, ",", false, false, "0,5", false, false ]
1030
- }
1031
- }, {
1032
- "name" : "userType",
1033
- "in" : "query",
1034
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
1035
- "required" : false,
1036
- "style" : "form",
1037
- "explode" : true,
1038
- "schema" : {
1039
- "type" : [ "string", "null" ],
1040
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
1041
- "enum" : [ "AGENTS", "REGISTERED_USERS", "ALL_USERS" ],
1042
- "maxLength" : 100,
1043
- "minLength" : 0
1044
- }
1045
- }, {
1046
- "$ref" : "#/components/parameters/from"
1047
- }, {
1048
- "$ref" : "#/components/parameters/timeRange"
1049
- }, {
1050
- "$ref" : "#/components/parameters/articleId"
1051
- }, {
1052
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1053
- } ],
1054
- "responses" : {
1055
- "422" : {
1056
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1057
- },
1058
- "200" : {
1059
- "$ref" : "#/components/responses/interactedUsersResponse"
1060
- }
1061
- },
1062
- "security" : [ {
1063
- "org-oauth" : [ "accessAll.ALL" ]
1064
- }, {
1065
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
1066
- } ],
1067
- "x-audience" : [ "company-internal" ],
1068
- "x-custom-url-attribute" : {
1069
- "security" : {
1070
- "throttle" : {
1071
- "policy" : "ReadAPI_Stringent_UserPolicy"
1072
- },
1073
- "extraparams" : {
1074
- "disable" : true,
1075
- "ignore" : false
1076
- },
1077
- "authentication" : { }
1078
- },
1079
- "clan-group" : "helpCenter",
1080
- "apihash" : "fc9070636bebabff16d9d00d4e929eac",
1081
- "module-group" : "kb",
1082
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getArticleTranslationInteractedUsers"
1083
- }
1084
- }
1085
- },
1086
- "/api/v1/articleDashboard/counts" : {
1087
- "get" : {
1088
- "tags" : [ "ArticleStatistics" ],
1089
- "summary" : "Get translation statistics",
1090
- "description" : "This API fetches the statistics related to article translations in your Knowledge Base.",
1091
- "operationId" : "getArticleTranslationStatistics",
1092
- "parameters" : [ {
1093
- "name" : "action",
1094
- "in" : "query",
1095
- "description" : "Action that the users performed. Values allowed are VIEW, LIKE, DISLIKE, COMMENT, FEEDBACK, TEMPLATE_USAGE and TICKET_USAGE. If you do not pass a value, all actions are included.",
1096
- "required" : true,
1097
- "style" : "simple",
1098
- "explode" : true,
1099
- "schema" : {
1100
- "type" : [ "null", "array" ],
1101
- "description" : "Action that the users performed. Values allowed are VIEW, LIKE, DISLIKE, COMMENT, FEEDBACK, TEMPLATE_USAGE and TICKET_USAGE. If you do not pass a value, all actions are included.",
1102
- "items" : {
1103
- "type" : [ "string", "null" ],
1104
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "TEMPLATE_USAGE", "FEEDBACK" ],
1105
- "maxLength" : 100,
1106
- "minLength" : 0,
1107
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@TEMPLATE_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.", false, 10, ",", false, false, "0,5", false, false ]
1108
- },
1109
- "maxItems" : 6,
1110
- "uniqueItems" : false
1111
- }
1112
- }, {
1113
- "$ref" : "#/components/parameters/rootCategoryIds"
1114
- }, {
1115
- "$ref" : "#/components/parameters/departmentIds"
1116
- }, {
1117
- "$ref" : "#/components/parameters/userType"
1118
- }, {
1119
- "$ref" : "#/components/parameters/locale"
1120
- }, {
1121
- "$ref" : "#/components/parameters/timeRange"
1122
- }, {
1123
- "$ref" : "#/components/parameters/actionSource"
1124
- }, {
1125
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1126
- } ],
1127
- "responses" : {
1128
- "422" : {
1129
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1130
- },
1131
- "200" : {
1132
- "$ref" : "#/components/responses/articleStatisticsResponse"
1133
- }
1134
- },
1135
- "security" : [ {
1136
- "org-oauth" : [ "accessAll.ALL" ]
1137
- }, {
1138
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
1139
- } ],
1140
- "x-audience" : [ "company-internal" ],
1141
- "x-custom-url-attribute" : {
1142
- "security" : {
1143
- "throttle" : {
1144
- "inline" : [ {
1145
- "scope" : "APPSERVER",
1146
- "rules" : [ {
1147
- "duration" : 60000,
1148
- "lock-period" : 600000,
1149
- "threshold" : 50,
1150
- "hip" : false
1151
- }, {
1152
- "duration" : 3600000,
1153
- "lock-period" : 1800000,
1154
- "threshold" : 300,
1155
- "hip" : false
1156
- } ],
1157
- "window" : "ROLLING",
1158
- "key" : "url.path+user.zuid"
1159
- } ]
1160
- },
1161
- "extraparams" : {
1162
- "disable" : true,
1163
- "ignore" : false
1164
- },
1165
- "authentication" : { }
1166
- },
1167
- "clan-group" : "helpCenter",
1168
- "apihash" : "9cd83711a12665e4eea7b9878e112e05",
1169
- "module-group" : "kb",
1170
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getArticleMetricsCounts"
1171
- }
1172
- }
1173
- },
1174
- "/api/v1/articles/{articleId}/interactedUsers" : {
1175
- "get" : {
1176
- "tags" : [ "ArticleStatistics" ],
1177
- "summary" : "List users who interacted with an article",
1178
- "description" : "This API lists a particular number of users who interacted with an article, based on the limit specified.",
1179
- "operationId" : "getArticleInteractedUsers",
1180
- "parameters" : [ {
1181
- "name" : "limit",
1182
- "in" : "query",
1183
- "description" : "Number of users to list. The default value is 10 and the maximum value allowed is 100.",
1184
- "required" : false,
1185
- "style" : "form",
1186
- "explode" : true,
1187
- "schema" : {
1188
- "type" : [ "string", "null", "integer" ],
1189
- "format" : "int32",
1190
- "description" : "Number of users to list. The default value is 10 and the maximum value allowed is 100.",
1191
- "maximum" : 100,
1192
- "minimum" : 1,
1193
- "pattern" : "([0-9]+)"
1194
- }
1195
- }, {
1196
- "name" : "action",
1197
- "in" : "query",
1198
- "description" : "Action that the users performed. Values allowed are !@LIKE@! and !@DISLIKE@!. default value is !@LIKE@!",
1199
- "required" : false,
1200
- "style" : "simple",
1201
- "explode" : true,
1202
- "schema" : {
1203
- "type" : [ "string", "null" ],
1204
- "description" : "Action that the users performed. Values allowed are !@LIKE@! and !@DISLIKE@!. default value is !@LIKE@!",
1205
- "enum" : [ "LIKE", "DISLIKE" ],
1206
- "maxLength" : 100,
1207
- "minLength" : 0,
1208
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.", false, 10, ",", false, false, "0,5", false, false ]
1209
- }
1210
- }, {
1211
- "name" : "userType",
1212
- "in" : "query",
1213
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
1214
- "required" : false,
1215
- "style" : "form",
1216
- "explode" : true,
1217
- "schema" : {
1218
- "type" : [ "string", "null" ],
1219
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
1220
- "enum" : [ "AGENTS", "REGISTERED_USERS", "ALL_USERS" ],
1221
- "maxLength" : 100,
1222
- "minLength" : 0
1223
- }
1224
- }, {
1225
- "$ref" : "#/components/parameters/from"
1226
- }, {
1227
- "$ref" : "#/components/parameters/timeRange"
1228
- }, {
1229
- "$ref" : "#/components/parameters/articleId"
1230
- }, {
1231
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1232
- } ],
1233
- "responses" : {
1234
- "422" : {
1235
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1236
- },
1237
- "200" : {
1238
- "$ref" : "#/components/responses/interactedUsersResponse"
1239
- }
1240
- },
1241
- "security" : [ {
1242
- "org-oauth" : [ "accessAll.ALL" ]
1243
- }, {
1244
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
1245
- } ],
1246
- "x-audience" : [ "company-internal" ],
1247
- "x-custom-url-attribute" : {
1248
- "security" : {
1249
- "throttle" : {
1250
- "policy" : "ReadAPI_Stringent_UserPolicy"
1251
- },
1252
- "extraparams" : {
1253
- "disable" : true,
1254
- "ignore" : false
1255
- },
1256
- "authentication" : { }
1257
- },
1258
- "clan-group" : "helpCenter",
1259
- "apihash" : "5e427e27c5f3fae9d44926d63f402b74",
1260
- "module-group" : "kb",
1261
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getArticleInteractedUsers"
1262
- }
1263
- }
1264
- },
1265
- "/api/v1/articles/{articleId}/translations/{locale}/insights/flush" : {
1266
- "post" : {
1267
- "tags" : [ "ArticleStatistics" ],
1268
- "summary" : "Update metrics of a translation in the article",
1269
- "description" : "This API updates the metrics on a translated version of an article.",
1270
- "operationId" : "updateArticleTranslationMetrics",
1271
- "parameters" : [ {
1272
- "name" : "locale",
1273
- "in" : "path",
1274
- "required" : true,
1275
- "style" : "simple",
1276
- "explode" : false,
1277
- "schema" : {
1278
- "type" : [ "string", "null" ],
1279
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1280
- "maxLength" : 100,
1281
- "minLength" : 0,
1282
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1283
- }
1284
- }, {
1285
- "$ref" : "#/components/parameters/articleId"
1286
- }, {
1287
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1288
- } ],
1289
- "requestBody" : {
1290
- "$ref" : "#/components/requestBodies/updateArticleTranslationMetrics_metricsUpdatePayload"
1291
- },
1292
- "responses" : {
1293
- "422" : {
1294
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1295
- },
1296
- "204" : {
1297
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1298
- }
1299
- },
1300
- "security" : [ {
1301
- "org-oauth" : [ "accessAll.ALL" ]
1302
- }, {
1303
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
1304
- } ],
1305
- "x-audience" : [ "company-internal" ],
1306
- "x-custom-url-attribute" : {
1307
- "security" : {
1308
- "throttle" : {
1309
- "inline" : [ {
1310
- "scope" : "APPSERVER",
1311
- "rules" : [ {
1312
- "duration" : 60000,
1313
- "lock-period" : 600000,
1314
- "threshold" : 5,
1315
- "hip" : false
1316
- }, {
1317
- "duration" : 3600000,
1318
- "lock-period" : 1800000,
1319
- "threshold" : 30,
1320
- "hip" : false
1321
- }, {
1322
- "duration" : 86400000,
1323
- "lock-period" : 3600000,
1324
- "threshold" : 100,
1325
- "hip" : false
1326
- } ],
1327
- "window" : "ROLLING",
1328
- "key" : "url.path+user.zuid"
1329
- } ]
1330
- },
1331
- "extraparams" : {
1332
- "disable" : true,
1333
- "ignore" : false
1334
- },
1335
- "authentication" : { }
1336
- },
1337
- "clan-group" : "helpCenter",
1338
- "apihash" : "d9a99c35441e77afd22fc529308b4f77",
1339
- "module-group" : "kb",
1340
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.flushTranslationMetricsCount"
1341
- }
1342
- }
1343
- },
1344
- "/api/v1/articleInsights/count" : {
1345
- "get" : {
1346
- "tags" : [ "ArticleStatistics" ],
1347
- "summary" : "Get Recent Insights Interacted users count of a translation",
1348
- "description" : "This API gets article translation insights interacted user counts based on the filters",
1349
- "operationId" : "getInsightsInteractedUsersCount",
1350
- "parameters" : [ {
1351
- "name" : "include",
1352
- "in" : "query",
1353
- "description" : "count fields need to fetched in API information. Comma separated allowed include fields !@actionCount@!, !@interactedUsersCount@!",
1354
- "required" : true,
1355
- "style" : "form",
1356
- "explode" : true,
1357
- "schema" : {
1358
- "type" : [ "string", "null" ],
1359
- "description" : "count fields need to fetched in API information. Comma separated allowed include fields !@actionCount@!, !@interactedUsersCount@!",
1360
- "enum" : [ "actionCount", "interactedUsersCount" ],
1361
- "maxLength" : 100,
1362
- "minLength" : 0,
1363
- "x-custom-parameters-attributes" : {
1364
- "split" : ","
1365
- }
1366
- }
1367
- }, {
1368
- "$ref" : "#/components/parameters/articleId"
1369
- }, {
1370
- "$ref" : "#/components/parameters/action"
1371
- }, {
1372
- "$ref" : "#/components/parameters/userType"
1373
- }, {
1374
- "$ref" : "#/components/parameters/locale"
1375
- }, {
1376
- "$ref" : "#/components/parameters/timeRange"
1377
- }, {
1378
- "$ref" : "#/components/parameters/actionSource"
1379
- }, {
1380
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1381
- } ],
1382
- "responses" : {
1383
- "422" : {
1384
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1385
- },
1386
- "200" : {
1387
- "$ref" : "#/components/responses/insightsActionCountJson"
1388
- }
1389
- },
1390
- "security" : [ {
1391
- "org-oauth" : [ "accessAll.ALL" ]
1392
- }, {
1393
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
1394
- } ],
1395
- "x-audience" : [ "company-internal" ],
1396
- "x-custom-url-attribute" : {
1397
- "security" : {
1398
- "throttle" : {
1399
- "policy" : "ReadAPI_Stringent_UserPolicy"
1400
- },
1401
- "extraparams" : {
1402
- "disable" : true,
1403
- "ignore" : false
1404
- },
1405
- "authentication" : { }
1406
- },
1407
- "clan-group" : "helpCenter",
1408
- "apihash" : "283b44d78fb5e9fe2966a1ca016583f5",
1409
- "module-group" : "kb",
1410
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getArticleInsightsCount"
1411
- }
1412
- }
1413
- },
1414
- "/api/v1/articles/{articleId}/translations/{locale}/interactedUsers/count" : {
1415
- "get" : {
1416
- "tags" : [ "ArticleStatistics" ],
1417
- "summary" : "Get Interacted users count of a translation",
1418
- "description" : "This API gets article translation interacted user counts based on the filters",
1419
- "operationId" : "getInteractedUsersCount",
1420
- "parameters" : [ {
1421
- "name" : "locale",
1422
- "in" : "path",
1423
- "required" : true,
1424
- "style" : "simple",
1425
- "explode" : false,
1426
- "schema" : {
1427
- "type" : [ "string", "null" ],
1428
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1429
- "maxLength" : 100,
1430
- "minLength" : 0,
1431
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1432
- }
1433
- }, {
1434
- "name" : "action",
1435
- "in" : "query",
1436
- "description" : "Action that the users performed. Values allowed are !@LIKE@!,!@DISLIKE@!. default value is !@LIKE@!",
1437
- "required" : false,
1438
- "style" : "simple",
1439
- "explode" : true,
1440
- "schema" : {
1441
- "type" : [ "string", "null" ],
1442
- "description" : "Action that the users performed. Values allowed are !@LIKE@!,!@DISLIKE@!. default value is !@LIKE@!",
1443
- "enum" : [ "LIKE", "DISLIKE" ],
1444
- "maxLength" : 100,
1445
- "minLength" : 0,
1446
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.", false, 10, ",", false, false, "0,5", false, false ]
1447
- }
1448
- }, {
1449
- "name" : "userType",
1450
- "in" : "query",
1451
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
1452
- "required" : false,
1453
- "style" : "form",
1454
- "explode" : true,
1455
- "schema" : {
1456
- "type" : [ "string", "null" ],
1457
- "description" : "Type of users. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! and !@ALL_USERS@! (default).",
1458
- "enum" : [ "AGENTS", "REGISTERED_USERS", "ALL_USERS" ],
1459
- "maxLength" : 100,
1460
- "minLength" : 0
1461
- }
1462
- }, {
1463
- "$ref" : "#/components/parameters/timeRange"
1464
- }, {
1465
- "$ref" : "#/components/parameters/articleId"
1466
- }, {
1467
- "$ref" : "../common/Common.json#/components/parameters/orgId"
1468
- } ],
1469
- "responses" : {
1470
- "422" : {
1471
- "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1472
- },
1473
- "200" : {
1474
- "$ref" : "#/components/responses/articleStatisticsResponse"
1475
- }
1476
- },
1477
- "security" : [ {
1478
- "org-oauth" : [ "accessAll.ALL" ]
1479
- }, {
1480
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
1481
- } ],
1482
- "x-audience" : [ "company-internal" ],
1483
- "x-custom-url-attribute" : {
1484
- "security" : {
1485
- "throttle" : {
1486
- "policy" : "ReadAPI_Stringent_UserPolicy"
1487
- },
1488
- "extraparams" : {
1489
- "disable" : true,
1490
- "ignore" : false
1491
- },
1492
- "authentication" : { }
1493
- },
1494
- "clan-group" : "helpCenter",
1495
- "apihash" : "8aa605343a57fb49f12358614cdcab7b",
1496
- "module-group" : "kb",
1497
- "apimethod" : "com.zoho.desk.helpcenter.articles.rest.support.ArticleDashboardService.getArticleTranslationInteractedUsersCount"
1498
- }
1499
- }
1500
- }
1501
- },
1502
- "components" : {
1503
- "schemas" : {
1504
- "dashboardStatisticsData" : {
1505
- "type" : [ "null", "object" ],
1506
- "additionalProperties" : false,
1507
- "properties" : {
1508
- "count" : {
1509
- "type" : [ "string", "null", "integer" ],
1510
- "format" : "int32",
1511
- "pattern" : "([0-9]+)"
1512
- },
1513
- "statsType" : {
1514
- "type" : [ "string", "null" ],
1515
- "enum" : [ "ARTICLES_REFERENCED", "VOTED_PORTAL_USERS", "CREATED_ARTICLES", "MODIFIED_ARTICLES" ],
1516
- "maxLength" : 100,
1517
- "minLength" : 0
1518
- }
1519
- },
1520
- "required" : [ "count", "statsType" ]
1521
- },
1522
- "dashboardStatisticsDataArray" : {
1523
- "type" : [ "null", "array" ],
1524
- "items" : {
1525
- "$ref" : "./ArticleStatistics.json#/components/schemas/dashboardStatisticsData"
1526
- }
1527
- },
1528
- "trendResponse" : {
1529
- "type" : [ "null", "object" ],
1530
- "additionalProperties" : false,
1531
- "properties" : {
1532
- "eventTime" : {
1533
- "type" : [ "string", "null" ],
1534
- "maxLength" : 100,
1535
- "minLength" : 0,
1536
- "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
1537
- },
1538
- "count" : {
1539
- "type" : [ "string", "null", "integer" ],
1540
- "format" : "int32",
1541
- "pattern" : "([0-9]+)"
1542
- },
1543
- "action" : {
1544
- "type" : [ "string", "null" ],
1545
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "FEEDBACK" ],
1546
- "maxLength" : 100,
1547
- "minLength" : 0,
1548
- "x-custom-parameters-attributes" : {
1549
- "removeExif" : false,
1550
- "filterMatchedContent" : false,
1551
- "antivirus" : false,
1552
- "replacementString" : "",
1553
- "allowInvalid" : false,
1554
- "descrption" : "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.",
1555
- "secret" : false,
1556
- "preserveCharsLimit" : 10,
1557
- "split" : ",",
1558
- "trim" : false,
1559
- "internalParam" : false,
1560
- "preserveChars" : "0,5",
1561
- "importUrl" : false,
1562
- "decrypt" : false
1563
- }
1564
- }
1565
- },
1566
- "required" : [ "action", "count", "eventTime" ]
1567
- },
1568
- "trendList" : {
1569
- "type" : [ "null", "array" ],
1570
- "items" : {
1571
- "$ref" : "./ArticleStatistics.json#/components/schemas/trendResponse"
1572
- }
1573
- },
1574
- "actionArray" : {
1575
- "type" : [ "null", "array" ],
1576
- "description" : "",
1577
- "items" : {
1578
- "type" : [ "string", "null" ],
1579
- "description" : "",
1580
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "FEEDBACK", "TEMPLATE_USAGE" ],
1581
- "maxLength" : 100,
1582
- "minLength" : 0,
1583
- "x-custom-parameters-attributes" : [ { } ]
1584
- }
1585
- },
1586
- "popularKeywordsJson" : {
1587
- "type" : [ "null", "object" ],
1588
- "additionalProperties" : false,
1589
- "properties" : {
1590
- "searchkeyword" : {
1591
- "type" : [ "string", "null" ],
1592
- "maxLength" : 100,
1593
- "minLength" : 0
1594
- },
1595
- "successCount" : {
1596
- "type" : [ "string", "null", "integer" ],
1597
- "format" : "int32",
1598
- "pattern" : "([0-9]+)"
1599
- }
1600
- },
1601
- "required" : [ "searchkeyword", "successCount" ]
1602
- },
1603
- "popularKeywordsData" : {
1604
- "type" : [ "null", "array" ],
1605
- "items" : {
1606
- "$ref" : "./ArticleStatistics.json#/components/schemas/popularKeywordsJson"
1607
- }
1608
- },
1609
- "failureKeywordsJson" : {
1610
- "type" : [ "null", "object" ],
1611
- "additionalProperties" : false,
1612
- "properties" : {
1613
- "searchkeyword" : {
1614
- "type" : [ "string", "null" ],
1615
- "maxLength" : 100,
1616
- "minLength" : 0
1617
- },
1618
- "failureCount" : {
1619
- "type" : [ "string", "null", "integer" ],
1620
- "format" : "int32",
1621
- "pattern" : "([0-9]+)"
1622
- }
1623
- },
1624
- "required" : [ "failureCount", "searchkeyword" ]
1625
- },
1626
- "failureKeywordsData" : {
1627
- "type" : [ "null", "array" ],
1628
- "items" : {
1629
- "$ref" : "./ArticleStatistics.json#/components/schemas/failureKeywordsJson"
1630
- }
1631
- },
1632
- "interactedUserMeta" : {
1633
- "type" : [ "null", "object" ],
1634
- "additionalProperties" : false,
1635
- "properties" : {
1636
- "photoURL" : {
1637
- "type" : [ "string", "null" ],
1638
- "maxLength" : 200,
1639
- "minLength" : 0,
1640
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1641
- },
1642
- "firstName" : {
1643
- "type" : [ "string", "null" ],
1644
- "maxLength" : 50,
1645
- "minLength" : 0
1646
- },
1647
- "lastName" : {
1648
- "type" : [ "string", "null" ],
1649
- "maxLength" : 50,
1650
- "minLength" : 0
1651
- },
1652
- "webUrl" : {
1653
- "type" : [ "string", "null" ],
1654
- "maxLength" : 255,
1655
- "minLength" : 3,
1656
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1657
- },
1658
- "roleName" : {
1659
- "type" : [ "string", "null" ],
1660
- "maxLength" : 100,
1661
- "minLength" : 0
1662
- },
1663
- "emailId" : {
1664
- "type" : [ "string", "null" ],
1665
- "maxLength" : 100,
1666
- "minLength" : 0,
1667
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1668
- },
1669
- "id" : {
1670
- "type" : [ "string", "null", "integer" ],
1671
- "format" : "int64",
1672
- "pattern" : "([0-9]+)"
1673
- },
1674
- "type" : {
1675
- "type" : [ "string", "null" ],
1676
- "enum" : [ "END_USER", "AGENT", "TEAM", "TICKET", "ACTIVITY" ],
1677
- "maxLength" : 100,
1678
- "minLength" : 0
1679
- }
1680
- },
1681
- "required" : [ "emailId", "firstName", "id", "lastName", "photoURL", "roleName", "type", "webUrl" ]
1682
- },
1683
- "interactedUsersData" : {
1684
- "type" : [ "null", "object" ],
1685
- "additionalProperties" : false,
1686
- "properties" : {
1687
- "action" : {
1688
- "type" : [ "string", "null" ],
1689
- "enum" : [ "LIKE", "DISLIKE", "VIEW" ],
1690
- "maxLength" : 100,
1691
- "minLength" : 0
1692
- },
1693
- "user" : {
1694
- "$ref" : "./ArticleStatistics.json#/components/schemas/interactedUserMeta"
1695
- }
1696
- },
1697
- "required" : [ "action", "user" ]
1698
- },
1699
- "interactedUsersDataArray" : {
1700
- "type" : [ "null", "array" ],
1701
- "items" : {
1702
- "$ref" : "./ArticleStatistics.json#/components/schemas/interactedUsersData"
1703
- }
1704
- },
1705
- "departmentIds" : {
1706
- "type" : [ "null", "array" ],
1707
- "items" : {
1708
- "type" : [ "string", "null", "integer" ],
1709
- "format" : "int64",
1710
- "pattern" : "([0-9]+)"
1711
- }
1712
- },
1713
- "rootCategoryIds" : {
1714
- "type" : [ "null", "array" ],
1715
- "items" : {
1716
- "type" : [ "string", "null", "integer" ],
1717
- "format" : "int64",
1718
- "pattern" : "([0-9]+)"
1719
- }
1720
- },
1721
- "timeBoundMetricsResponse" : {
1722
- "type" : [ "null", "object" ],
1723
- "additionalProperties" : false,
1724
- "properties" : {
1725
- "count" : {
1726
- "type" : [ "string", "null", "integer" ],
1727
- "format" : "int32",
1728
- "pattern" : "([0-9]+)"
1729
- },
1730
- "action" : {
1731
- "type" : [ "string", "null" ],
1732
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "FEEDBACK", "TEMPLATE_USAGE" ],
1733
- "maxLength" : 100,
1734
- "minLength" : 0,
1735
- "x-custom-parameters-attributes" : {
1736
- "removeExif" : false,
1737
- "filterMatchedContent" : false,
1738
- "antivirus" : false,
1739
- "replacementString" : "",
1740
- "allowInvalid" : false,
1741
- "descrption" : "User action that serves as the condition to apply. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!",
1742
- "secret" : false,
1743
- "preserveCharsLimit" : 10,
1744
- "trim" : false,
1745
- "internalParam" : false,
1746
- "preserveChars" : "0,5",
1747
- "importUrl" : false,
1748
- "decrypt" : false
1749
- }
1750
- }
1751
- },
1752
- "required" : [ "action", "count" ]
1753
- },
1754
- "timeBoundMetrics" : {
1755
- "type" : [ "null", "array" ],
1756
- "items" : {
1757
- "$ref" : "./ArticleStatistics.json#/components/schemas/timeBoundMetricsResponse"
1758
- }
1759
- },
1760
- "topArticleReportResponseData" : {
1761
- "type" : [ "null", "object" ],
1762
- "additionalProperties" : false,
1763
- "properties" : {
1764
- "modifiedTime" : {
1765
- "type" : [ "string", "null" ],
1766
- "maxLength" : 100,
1767
- "minLength" : 0,
1768
- "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
1769
- },
1770
- "departmentId" : {
1771
- "type" : [ "string", "null", "integer" ],
1772
- "format" : "int64",
1773
- "pattern" : "([0-9]+)"
1774
- },
1775
- "modifierId" : {
1776
- "type" : [ "string", "null", "integer" ],
1777
- "format" : "int64",
1778
- "pattern" : "([0-9]+)"
1779
- },
1780
- "creatorId" : {
1781
- "type" : [ "string", "null", "integer" ],
1782
- "format" : "int64",
1783
- "pattern" : "([0-9]+)"
1784
- },
1785
- "ownerId" : {
1786
- "type" : [ "string", "null", "integer" ],
1787
- "format" : "int64",
1788
- "pattern" : "([0-9]+)"
1789
- },
1790
- "title" : {
1791
- "type" : [ "string", "null" ],
1792
- "maxLength" : 500,
1793
- "minLength" : 0
1794
- },
1795
- "locale" : {
1796
- "type" : [ "string", "null" ],
1797
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1798
- "maxLength" : 100,
1799
- "minLength" : 0,
1800
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
1801
- "x-custom-parameters-attributes" : {
1802
- "removeExif" : false,
1803
- "filterMatchedContent" : false,
1804
- "antivirus" : false,
1805
- "replacementString" : "",
1806
- "allowInvalid" : false,
1807
- "descrption" : "Language of the translations.",
1808
- "secret" : false,
1809
- "preserveCharsLimit" : 10,
1810
- "trim" : false,
1811
- "internalParam" : false,
1812
- "preserveChars" : "0,5",
1813
- "importUrl" : false,
1814
- "decrypt" : false
1815
- }
1816
- },
1817
- "translationState" : {
1818
- "type" : [ "string", "null" ],
1819
- "enum" : [ "OUTDATED", "UP-TO-DATE", "AUTO-TRANSLATE INPROGRESS", "AUTO-TRANSLATE FAILED" ],
1820
- "maxLength" : 100,
1821
- "minLength" : 0
1822
- },
1823
- "isTrashed" : {
1824
- "type" : [ "boolean", "null" ]
1825
- },
1826
- "createdTime" : {
1827
- "type" : [ "string", "null" ],
1828
- "maxLength" : 100,
1829
- "minLength" : 0,
1830
- "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
1831
- },
1832
- "modifiedBy" : {
1833
- "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy"
1834
- },
1835
- "id" : {
1836
- "type" : [ "string", "null", "integer" ],
1837
- "format" : "int64",
1838
- "pattern" : "([0-9]+)"
1839
- },
1840
- "timeBoundMetrics" : {
1841
- "$ref" : "./ArticleStatistics.json#/components/schemas/timeBoundMetrics"
1842
- },
1843
- "summary" : {
1844
- "type" : [ "string", "null" ],
1845
- "maxLength" : 500,
1846
- "minLength" : 0
1847
- },
1848
- "owner" : {
1849
- "$ref" : "./ArticleTranslation.json#/components/schemas/owner"
1850
- },
1851
- "latestVersionStatus" : {
1852
- "type" : [ "string", "null" ],
1853
- "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished", "Auto-translate Pending" ],
1854
- "maxLength" : 100,
1855
- "minLength" : 0
1856
- },
1857
- "author" : {
1858
- "$ref" : "./ArticleTranslation.json#/components/schemas/author"
1859
- },
1860
- "permission" : {
1861
- "type" : [ "string", "null" ],
1862
- "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ],
1863
- "maxLength" : 100,
1864
- "minLength" : 0
1865
- },
1866
- "authorId" : {
1867
- "type" : [ "string", "null", "integer" ],
1868
- "format" : "int64",
1869
- "pattern" : "([0-9]+)"
1870
- },
1871
- "rootCategoryId" : {
1872
- "type" : [ "string", "null", "integer" ],
1873
- "format" : "int64",
1874
- "pattern" : "([0-9]+)"
1875
- },
1876
- "sourceLocale" : {
1877
- "type" : [ "string", "null" ],
1878
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1879
- "maxLength" : 100,
1880
- "minLength" : 0,
1881
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
1882
- "x-custom-parameters-attributes" : {
1883
- "removeExif" : false,
1884
- "filterMatchedContent" : false,
1885
- "antivirus" : false,
1886
- "replacementString" : "",
1887
- "allowInvalid" : false,
1888
- "descrption" : "Language of the translations.",
1889
- "secret" : false,
1890
- "preserveCharsLimit" : 10,
1891
- "trim" : false,
1892
- "internalParam" : false,
1893
- "preserveChars" : "0,5",
1894
- "importUrl" : false,
1895
- "decrypt" : false
1896
- }
1897
- },
1898
- "translationId" : {
1899
- "type" : [ "string", "null", "integer" ],
1900
- "format" : "int64",
1901
- "pattern" : "([0-9]+)"
1902
- },
1903
- "latestVersion" : {
1904
- "type" : [ "string", "null" ],
1905
- "maxLength" : 100,
1906
- "minLength" : 0
1907
- },
1908
- "createdBy" : {
1909
- "$ref" : "./ArticleTranslation.json#/components/schemas/createdBy"
1910
- },
1911
- "webUrl" : {
1912
- "type" : [ "string", "null" ],
1913
- "maxLength" : 500,
1914
- "minLength" : 0,
1915
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1916
- },
1917
- "latestPublishedVersion" : {
1918
- "type" : [ "string", "null" ],
1919
- "maxLength" : 100,
1920
- "minLength" : 0
1921
- },
1922
- "category" : {
1923
- "$ref" : "./ArticleTranslation.json#/components/schemas/category"
1924
- },
1925
- "permalink" : {
1926
- "type" : [ "string", "null" ],
1927
- "maxLength" : 300,
1928
- "minLength" : 0,
1929
- "pattern" : "[A-Za-z0-9%\\-+\\/=\\P{InBasicLatin}]+"
1930
- },
1931
- "categoryId" : {
1932
- "type" : [ "string", "null", "integer" ],
1933
- "format" : "int64",
1934
- "pattern" : "([0-9]+)"
1935
- },
1936
- "status" : {
1937
- "type" : [ "string", "null" ],
1938
- "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished", "Auto-translate Pending" ],
1939
- "maxLength" : 100,
1940
- "minLength" : 0
1941
- }
1942
- },
1943
- "required" : [ "author", "authorId", "category", "categoryId", "createdBy", "createdTime", "creatorId", "departmentId", "id", "isTrashed", "latestPublishedVersion", "latestVersion", "latestVersionStatus", "locale", "modifiedBy", "modifiedTime", "modifierId", "owner", "ownerId", "permalink", "permission", "rootCategoryId", "sourceLocale", "status", "summary", "timeBoundMetrics", "title", "translationId", "translationState", "webUrl" ]
1944
- },
1945
- "topArticleReportResponseDataArray" : {
1946
- "type" : [ "null", "array" ],
1947
- "items" : {
1948
- "$ref" : "./ArticleStatistics.json#/components/schemas/topArticleReportResponseData"
1949
- }
1950
- },
1951
- "articleStatisticsData" : {
1952
- "type" : [ "null", "object" ],
1953
- "additionalProperties" : false,
1954
- "properties" : {
1955
- "count" : {
1956
- "type" : [ "string", "null", "integer" ],
1957
- "format" : "int32",
1958
- "pattern" : "([0-9]+)"
1959
- },
1960
- "action" : {
1961
- "type" : [ "string", "null" ],
1962
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "FEEDBACK", "TEMPLATE_USAGE" ],
1963
- "maxLength" : 100,
1964
- "minLength" : 0,
1965
- "x-custom-parameters-attributes" : {
1966
- "removeExif" : false,
1967
- "filterMatchedContent" : false,
1968
- "antivirus" : false,
1969
- "replacementString" : "",
1970
- "allowInvalid" : false,
1971
- "descrption" : "Action that the users performed. Values allowed are VIEW, LIKE, DISLIKE, COMMENT, FEEDBACK, and TICKET_USAGE. If you do not pass a value, all actions are included.",
1972
- "secret" : false,
1973
- "preserveCharsLimit" : 10,
1974
- "split" : ",",
1975
- "trim" : false,
1976
- "internalParam" : false,
1977
- "preserveChars" : "0,5",
1978
- "importUrl" : false,
1979
- "decrypt" : false
1980
- }
1981
- }
1982
- },
1983
- "required" : [ "action", "count" ]
1984
- },
1985
- "articleStatisticsDataArray" : {
1986
- "type" : [ "null", "array" ],
1987
- "items" : {
1988
- "$ref" : "./ArticleStatistics.json#/components/schemas/articleStatisticsData"
1989
- }
1990
- },
1991
- "insightsActionCountMetaJson" : {
1992
- "type" : [ "null", "object" ],
1993
- "additionalProperties" : false,
1994
- "properties" : {
1995
- "userType" : {
1996
- "type" : [ "string", "null" ],
1997
- "enum" : [ "AGENTS", "REGISTERED_USERS", "PUBLIC_USERS", "END_USERS", "ALL_USERS" ],
1998
- "maxLength" : 100,
1999
- "minLength" : 0,
2000
- "x-custom-parameters-attributes" : {
2001
- "removeExif" : false,
2002
- "filterMatchedContent" : false,
2003
- "antivirus" : false,
2004
- "replacementString" : "",
2005
- "allowInvalid" : false,
2006
- "descrption" : "Comma separated property. Type of users, Values allowed are: !@AGENTS,@! !@REGISTERED_USERS@! !@PUBLIC_USERS@! and !@ALL_USERS@! (default).",
2007
- "secret" : false,
2008
- "preserveCharsLimit" : 10,
2009
- "split" : ",",
2010
- "trim" : false,
2011
- "internalParam" : false,
2012
- "preserveChars" : "0,5",
2013
- "importUrl" : false,
2014
- "decrypt" : false
2015
- }
2016
- }
2017
- },
2018
- "required" : [ "userType" ]
2019
- },
2020
- "insightsActionDataArray" : {
2021
- "type" : [ "null", "array" ],
2022
- "items" : {
2023
- "$ref" : "./ArticleStatistics.json#/components/schemas/insightsActionCountMetaJson"
2024
- }
2025
- }
2026
- },
2027
- "responses" : {
2028
- "kbDashboardStatisticsResponse" : {
2029
- "description" : "kbDashboardStatisticsResponse template definitions",
2030
- "content" : {
2031
- "application/json" : {
2032
- "schema" : {
2033
- "type" : [ "null", "object" ],
2034
- "additionalProperties" : false,
2035
- "properties" : {
2036
- "data" : {
2037
- "$ref" : "./ArticleStatistics.json#/components/schemas/dashboardStatisticsDataArray"
2038
- }
2039
- },
2040
- "required" : [ "data" ]
2041
- },
2042
- "examples" : {
2043
- "Valid responses Definitions" : {
2044
- "value" : {
2045
- "data" : [ {
2046
- "count" : "99",
2047
- "statsType" : "ARTICLES_REFERENCED"
2048
- }, {
2049
- "count" : "75",
2050
- "statsType" : "VOTED_PORTAL_USERS"
2051
- }, {
2052
- "count" : "108",
2053
- "statsType" : "CREATED_ARTICLES"
2054
- }, {
2055
- "count" : "135",
2056
- "statsType" : "MODIFIED_ARTICLES"
2057
- } ]
2058
- }
2059
- }
2060
- }
2061
- }
2062
- },
2063
- "x-custom-response-attributes" : {
2064
- "disable-safe-headers" : "[]"
2065
- }
2066
- },
2067
- "articleTrendResponse" : {
2068
- "description" : "articleTrendResponse template definitions",
2069
- "content" : {
2070
- "application/json" : {
2071
- "schema" : {
2072
- "type" : [ "null", "object" ],
2073
- "additionalProperties" : false,
2074
- "properties" : {
2075
- "fromTime" : {
2076
- "type" : [ "string", "null" ],
2077
- "maxLength" : 100,
2078
- "minLength" : 0,
2079
- "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
2080
- },
2081
- "plotUnitType" : {
2082
- "type" : [ "string", "null" ],
2083
- "enum" : [ "hourly" ],
2084
- "maxLength" : 100,
2085
- "minLength" : 0
2086
- },
2087
- "userType" : {
2088
- "type" : [ "string", "null" ],
2089
- "enum" : [ "AGENTS", "REGISTERED_USERS", "PUBLIC_USERS", "END_USERS", "ALL_USERS" ],
2090
- "maxLength" : 100,
2091
- "minLength" : 0,
2092
- "x-custom-parameters-attributes" : {
2093
- "removeExif" : false,
2094
- "filterMatchedContent" : false,
2095
- "antivirus" : false,
2096
- "replacementString" : "",
2097
- "allowInvalid" : false,
2098
- "descrption" : "Type of users. Values allowed are: AGENTS, REGISTERED_USERS, PUBLIC_USERS, END_USERS and ALL_USERS (default).",
2099
- "secret" : false,
2100
- "preserveCharsLimit" : 10,
2101
- "trim" : false,
2102
- "internalParam" : false,
2103
- "preserveChars" : "0,5",
2104
- "importUrl" : false,
2105
- "decrypt" : false
2106
- }
2107
- },
2108
- "trends" : {
2109
- "$ref" : "./ArticleStatistics.json#/components/schemas/trendList"
2110
- },
2111
- "toTime" : {
2112
- "type" : [ "string", "null" ],
2113
- "maxLength" : 100,
2114
- "minLength" : 0,
2115
- "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
2116
- }
2117
- },
2118
- "required" : [ "fromTime", "plotUnitType", "toTime", "trends", "userType" ]
2119
- },
2120
- "examples" : {
2121
- "Valid responses Definitions" : {
2122
- "value" : {
2123
- "fromTime" : 1589130000000,
2124
- "plotUnitType" : "hourly",
2125
- "userType" : "ALL_USERS",
2126
- "trends" : [ {
2127
- "eventTime" : 1589612548000,
2128
- "count" : "12",
2129
- "action" : "VIEW"
2130
- }, {
2131
- "eventTime" : 1589616416000,
2132
- "count" : "80",
2133
- "action" : "VIEW"
2134
- }, {
2135
- "eventTime" : 1589619809000,
2136
- "count" : "64",
2137
- "action" : "VIEW"
2138
- }, {
2139
- "eventTime" : 1589612541000,
2140
- "count" : "10",
2141
- "action" : "LIKE"
2142
- }, {
2143
- "eventTime" : 1589619754000,
2144
- "count" : "50",
2145
- "action" : "LIKE"
2146
- } ],
2147
- "toTime" : 1591809067000
2148
- }
2149
- }
2150
- }
2151
- }
2152
- },
2153
- "x-custom-response-attributes" : {
2154
- "disable-safe-headers" : "[]"
2155
- }
2156
- },
2157
- "getSearchKeywordsResponse" : {
2158
- "description" : "getSearchKeywordsResponse template definitions",
2159
- "content" : {
2160
- "application/json" : {
2161
- "schema" : {
2162
- "oneOf" : [ {
2163
- "type" : [ "null", "object" ],
2164
- "additionalProperties" : false,
2165
- "properties" : {
2166
- "overallSuccessKeywordsCount" : {
2167
- "type" : [ "string", "null", "integer" ],
2168
- "format" : "int32",
2169
- "pattern" : "([0-9]+)"
2170
- },
2171
- "failureKeywords" : {
2172
- "$ref" : "./ArticleStatistics.json#/components/schemas/failureKeywordsData"
2173
- },
2174
- "popularKeywords" : {
2175
- "$ref" : "./ArticleStatistics.json#/components/schemas/popularKeywordsData"
2176
- },
2177
- "overallFailureKeywordsCount" : {
2178
- "type" : [ "string", "null", "integer" ],
2179
- "format" : "int32",
2180
- "pattern" : "([0-9]+)"
2181
- }
2182
- },
2183
- "required" : [ "failureKeywords", "overallFailureKeywordsCount", "overallSuccessKeywordsCount", "popularKeywords" ]
2184
- }, {
2185
- "type" : [ "null", "object" ],
2186
- "additionalProperties" : false,
2187
- "properties" : {
2188
- "failureKeywords" : {
2189
- "$ref" : "./ArticleStatistics.json#/components/schemas/failureKeywordsData"
2190
- },
2191
- "overallFailureKeywordsCount" : {
2192
- "type" : [ "string", "null", "integer" ],
2193
- "format" : "int32",
2194
- "pattern" : "([0-9]+)"
2195
- }
2196
- },
2197
- "required" : [ "failureKeywords", "overallFailureKeywordsCount" ]
2198
- }, {
2199
- "type" : [ "null", "object" ],
2200
- "additionalProperties" : false,
2201
- "properties" : {
2202
- "overallSuccessKeywordsCount" : {
2203
- "type" : [ "string", "null", "integer" ],
2204
- "format" : "int32",
2205
- "pattern" : "([0-9]+)"
2206
- },
2207
- "popularKeywords" : {
2208
- "$ref" : "./ArticleStatistics.json#/components/schemas/popularKeywordsData"
2209
- }
2210
- },
2211
- "required" : [ "overallSuccessKeywordsCount", "popularKeywords" ]
2212
- } ]
2213
- },
2214
- "examples" : {
2215
- "Valid responses Definitions" : {
2216
- "value" : {
2217
- "overallSuccessKeywordsCount" : "11180",
2218
- "failureKeywords" : [ {
2219
- "searchkeyword" : "Welcome",
2220
- "failureCount" : "1"
2221
- } ],
2222
- "popularKeywords" : [ {
2223
- "searchkeyword" : "image",
2224
- "successCount" : "1"
2225
- } ],
2226
- "overallFailureKeywordsCount" : "2500"
2227
- }
2228
- }
2229
- }
2230
- }
2231
- },
2232
- "x-custom-response-attributes" : {
2233
- "disable-safe-headers" : "[]"
2234
- }
2235
- },
2236
- "interactedUsersResponse" : {
2237
- "description" : "interactedUsersResponse template definitions",
2238
- "content" : {
2239
- "application/json" : {
2240
- "schema" : {
2241
- "type" : [ "null", "object" ],
2242
- "additionalProperties" : false,
2243
- "properties" : {
2244
- "data" : {
2245
- "$ref" : "./ArticleStatistics.json#/components/schemas/interactedUsersDataArray"
2246
- }
2247
- },
2248
- "required" : [ "data" ]
2249
- },
2250
- "examples" : {
2251
- "Valid responses Definitions" : {
2252
- "value" : {
2253
- "data" : [ {
2254
- "action" : "LIKE",
2255
- "user" : {
2256
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000000063/photo?orgId=15234553",
2257
- "firstName" : "Charlie",
2258
- "lastName" : "Stankovic",
2259
- "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/3000000039220",
2260
- "emailId" : "charlie@zylker.com",
2261
- "id" : "4000000000063",
2262
- "type" : "AGENT"
2263
- }
2264
- }, {
2265
- "action" : "LIKE",
2266
- "user" : {
2267
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000000065/photo?orgId=15234553",
2268
- "firstName" : "Lisa",
2269
- "lastName" : "Roseland",
2270
- "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/3000000039255",
2271
- "emailId" : "lisa@zylker.com",
2272
- "id" : "4000000000065",
2273
- "type" : "REGISTERED_USERS"
2274
- }
2275
- } ]
2276
- }
2277
- }
2278
- }
2279
- }
2280
- },
2281
- "x-custom-response-attributes" : {
2282
- "disable-safe-headers" : "[]"
2283
- }
2284
- },
2285
- "topArticleReportResponse" : {
2286
- "description" : "topArticleReportResponse template definitions",
2287
- "content" : {
2288
- "application/json" : {
2289
- "schema" : {
2290
- "type" : [ "null", "object" ],
2291
- "additionalProperties" : false,
2292
- "properties" : {
2293
- "data" : {
2294
- "$ref" : "./ArticleStatistics.json#/components/schemas/topArticleReportResponseDataArray"
2295
- }
2296
- },
2297
- "required" : [ "data" ]
2298
- },
2299
- "examples" : {
2300
- "Valid responses Definitions" : {
2301
- "value" : {
2302
- "data" : [ {
2303
- "modifiedTime" : 1588301001000,
2304
- "departmentId" : "4000000038148",
2305
- "creatorId" : "4000000016508",
2306
- "modifierId" : "4000000016508",
2307
- "ownerId" : "4000000016508",
2308
- "title" : "Tom and jerry end game",
2309
- "latestVersionModifierId" : "4000000000060",
2310
- "locale" : "en",
2311
- "translationState" : "UP-TO-DATE",
2312
- "isTrashed" : false,
2313
- "createdTime" : 1588300921000,
2314
- "modifiedBy" : {
2315
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2316
- "name" : "Charlie",
2317
- "id" : "4000000016508",
2318
- "status" : "ACTIVE",
2319
- "zuid" : "234543"
2320
- },
2321
- "id" : "4000000081313",
2322
- "timeBoundMetrics" : [ {
2323
- "count" : "809",
2324
- "action" : "VIEW"
2325
- }, {
2326
- "count" : "478",
2327
- "action" : "LIKE"
2328
- }, {
2329
- "count" : "56",
2330
- "action" : "DISLIKE"
2331
- }, {
2332
- "count" : "336",
2333
- "action" : "COMMENT"
2334
- }, {
2335
- "count" : "125",
2336
- "action" : "TICKET_USAGE"
2337
- }, {
2338
- "count" : "15",
2339
- "action" : "FEEDBACK"
2340
- } ],
2341
- "summary" : "Tom and jerry. Its mysterious story",
2342
- "owner" : {
2343
- "photoURL" : null,
2344
- "name" : "Charlie",
2345
- "id" : "4000000016508",
2346
- "status" : "ACTIVE",
2347
- "zuid" : "234543"
2348
- },
2349
- "latestVersionStatus" : "Published",
2350
- "author" : {
2351
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2352
- "name" : "Charlie",
2353
- "id" : "4000000016508",
2354
- "status" : "ACTIVE",
2355
- "zuid" : "234543"
2356
- },
2357
- "permission" : "REGISTEREDUSERS",
2358
- "authorId" : "4000000016508",
2359
- "rootCategoryId" : "4000000081037",
2360
- "sourceLocale" : "en",
2361
- "translationId" : "4000000081315",
2362
- "latestVersion" : "2.0",
2363
- "createdBy" : {
2364
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2365
- "name" : "Charlie",
2366
- "id" : "4000000016508",
2367
- "status" : "ACTIVE",
2368
- "zuid" : "234543"
2369
- },
2370
- "webUrl" : "https://desk.zoho.com/support/solosolo/ShowHomePage.do#Solutions/dv/4000000081313/en",
2371
- "latestPublishedVersion" : "2.0",
2372
- "category" : {
2373
- "name" : "Cartoon",
2374
- "id" : "4000000081052",
2375
- "locale" : "en"
2376
- },
2377
- "permalink" : "tom-jerry",
2378
- "categoryId" : "4000000081052",
2379
- "latestVersionModifiedBy" : {
2380
- "photoURL" : null,
2381
- "name" : "will smith",
2382
- "id" : "4000000000060",
2383
- "status" : "ACTIVE",
2384
- "zuid" : "234544"
2385
- },
2386
- "status" : "Published"
2387
- }, {
2388
- "modifiedTime" : 1588300893000,
2389
- "departmentId" : "4000000038148",
2390
- "creatorId" : "4000000016508",
2391
- "modifierId" : "4000000016508",
2392
- "ownerId" : "4000000016508",
2393
- "title" : "Scooby doo",
2394
- "locale" : "en",
2395
- "translationState" : "UP-TO-DATE",
2396
- "isTrashed" : false,
2397
- "createdTime" : 1588300855000,
2398
- "modifiedBy" : {
2399
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2400
- "name" : "Charlie",
2401
- "id" : "4000000016508",
2402
- "status" : "ACTIVE",
2403
- "zuid" : "234543"
2404
- },
2405
- "id" : "4000000081268",
2406
- "timeBoundMetrics" : [ {
2407
- "count" : "809",
2408
- "action" : "VIEW"
2409
- }, {
2410
- "count" : "478",
2411
- "action" : "LIKE"
2412
- }, {
2413
- "count" : "56",
2414
- "action" : "DISLIKE"
2415
- }, {
2416
- "count" : "136",
2417
- "action" : "COMMENT"
2418
- }, {
2419
- "count" : "125",
2420
- "action" : "TICKET_USAGE"
2421
- }, {
2422
- "count" : "55",
2423
- "action" : "FEEDBACK"
2424
- } ],
2425
- "summary" : "Scooby doo infinity",
2426
- "owner" : {
2427
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2428
- "name" : "Charlie",
2429
- "id" : "4000000016508",
2430
- "status" : "ACTIVE",
2431
- "zuid" : "234543"
2432
- },
2433
- "latestVersionStatus" : "Published",
2434
- "author" : {
2435
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2436
- "name" : "Charlie",
2437
- "id" : "4000000016508",
2438
- "status" : "ACTIVE",
2439
- "zuid" : "234543"
2440
- },
2441
- "permission" : "REGISTEREDUSERS",
2442
- "authorId" : "4000000016508",
2443
- "rootCategoryId" : "4000000081037",
2444
- "sourceLocale" : "en",
2445
- "translationId" : "4000000081270",
2446
- "latestVersion" : "1.0",
2447
- "createdBy" : {
2448
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2449
- "name" : "Charlie",
2450
- "id" : "4000000016508",
2451
- "status" : "ACTIVE",
2452
- "zuid" : "234543"
2453
- },
2454
- "webUrl" : "https://desk.zoho.com/support/solosolo/ShowHomePage.do#Solutions/dv/4000000081268/en",
2455
- "latestPublishedVersion" : "1.0",
2456
- "category" : {
2457
- "name" : "Disney",
2458
- "id" : "4000000081052",
2459
- "locale" : "en"
2460
- },
2461
- "permalink" : "scooby-doo",
2462
- "categoryId" : "4000000081052",
2463
- "status" : "Published"
2464
- }, {
2465
- "modifiedTime" : 1588310888000,
2466
- "departmentId" : "4000000038148",
2467
- "creatorId" : "4000000016508",
2468
- "modifierId" : "4000000016508",
2469
- "ownerId" : "4000000016508",
2470
- "title" : "Yanni and music",
2471
- "locale" : "en",
2472
- "translationState" : "UP-TO-DATE",
2473
- "isTrashed" : false,
2474
- "createdTime" : 1588310873000,
2475
- "modifiedBy" : {
2476
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2477
- "name" : "Charlie",
2478
- "id" : "4000000016508",
2479
- "status" : "ACTIVE",
2480
- "zuid" : "234543"
2481
- },
2482
- "id" : "4000000088001",
2483
- "timeBoundMetrics" : [ {
2484
- "count" : "809",
2485
- "action" : "VIEW"
2486
- }, {
2487
- "count" : "478",
2488
- "action" : "LIKE"
2489
- }, {
2490
- "count" : "56",
2491
- "action" : "DISLIKE"
2492
- }, {
2493
- "count" : "86",
2494
- "action" : "COMMENT"
2495
- }, {
2496
- "count" : "125",
2497
- "action" : "TICKET_USAGE"
2498
- }, {
2499
- "count" : "5",
2500
- "action" : "FEEDBACK"
2501
- } ],
2502
- "summary" : "Yanni and notsolgia exploration",
2503
- "owner" : {
2504
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2505
- "name" : "Charlie",
2506
- "id" : "4000000016508",
2507
- "status" : "ACTIVE",
2508
- "zuid" : "234543"
2509
- },
2510
- "latestVersionStatus" : "Published",
2511
- "author" : {
2512
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2513
- "name" : "Charlie",
2514
- "id" : "4000000016508",
2515
- "status" : "ACTIVE",
2516
- "zuid" : "234543"
2517
- },
2518
- "permission" : "REGISTEREDUSERS",
2519
- "authorId" : "4000000016508",
2520
- "rootCategoryId" : "4000000081037",
2521
- "sourceLocale" : "en",
2522
- "translationId" : "4000000088003",
2523
- "latestVersion" : "1.0",
2524
- "createdBy" : {
2525
- "photoURL" : "https://desk.zoho.com/api/v1/agents/4000000016508/photo?orgId=292828",
2526
- "name" : "Charlie",
2527
- "id" : "4000000016508",
2528
- "status" : "ACTIVE",
2529
- "zuid" : "234543"
2530
- },
2531
- "webUrl" : "https://desk.zoho.com/support/solosolo/ShowHomePage.do#Solutions/dv/4000000088001/en",
2532
- "latestPublishedVersion" : "1.0",
2533
- "category" : {
2534
- "name" : "Music",
2535
- "id" : "4000000081052",
2536
- "locale" : "en"
2537
- },
2538
- "permalink" : "yanni-nostalgia",
2539
- "categoryId" : "4000000081052",
2540
- "status" : "Published"
2541
- } ]
2542
- }
2543
- }
2544
- }
2545
- }
2546
- },
2547
- "x-custom-response-attributes" : {
2548
- "disable-safe-headers" : "[]"
2549
- }
2550
- },
2551
- "articleStatisticsResponse" : {
2552
- "description" : "articleStatisticsResponse template definitions",
2553
- "content" : {
2554
- "application/json" : {
2555
- "schema" : {
2556
- "type" : [ "null", "object" ],
2557
- "additionalProperties" : false,
2558
- "properties" : {
2559
- "data" : {
2560
- "$ref" : "./ArticleStatistics.json#/components/schemas/articleStatisticsDataArray"
2561
- }
2562
- },
2563
- "required" : [ "data" ]
2564
- },
2565
- "examples" : {
2566
- "Valid responses Definitions" : {
2567
- "value" : {
2568
- "data" : [ {
2569
- "count" : "478",
2570
- "action" : "LIKE"
2571
- } ]
2572
- }
2573
- }
2574
- }
2575
- }
2576
- },
2577
- "x-custom-response-attributes" : {
2578
- "disable-safe-headers" : "[]"
2579
- }
2580
- },
2581
- "insightsActionCountJson" : {
2582
- "description" : "insightsActionCountJson template definitions",
2583
- "content" : {
2584
- "application/json" : {
2585
- "schema" : {
2586
- "allOf" : [ {
2587
- "type" : "object",
2588
- "properties" : {
2589
- "data" : {
2590
- "type" : "array",
2591
- "items" : {
2592
- "type" : "object",
2593
- "properties" : {
2594
- "actionCount" : {
2595
- "type" : [ "string", "null", "integer" ],
2596
- "format" : "int32",
2597
- "pattern" : "([0-9]+)"
2598
- },
2599
- "interactedUsersCount" : {
2600
- "type" : [ "string", "null", "integer" ],
2601
- "format" : "int32",
2602
- "pattern" : "([0-9]+)"
2603
- }
2604
- }
2605
- }
2606
- }
2607
- }
2608
- }, {
2609
- "type" : [ "null", "object" ],
2610
- "additionalProperties" : false,
2611
- "properties" : {
2612
- "data" : {
2613
- "$ref" : "./ArticleStatistics.json#/components/schemas/insightsActionDataArray"
2614
- }
2615
- },
2616
- "required" : [ "data" ]
2617
- } ]
2618
- },
2619
- "examples" : {
2620
- "Valid responses Definitions" : {
2621
- "value" : {
2622
- "data" : [ {
2623
- "actionCount" : 191,
2624
- "interactedUsersCount" : 1,
2625
- "userType" : "AGENTS"
2626
- }, {
2627
- "actionCount" : 3808,
2628
- "interactedUsersCount" : 2001,
2629
- "userType" : "REGISTERED_USERS"
2630
- }, {
2631
- "actionCount" : 35,
2632
- "interactedUsersCount" : 0,
2633
- "userType" : "PUBLIC_USERS"
2634
- } ]
2635
- }
2636
- }
2637
- }
2638
- }
2639
- },
2640
- "x-custom-response-attributes" : {
2641
- "disable-safe-headers" : "[]"
2642
- }
2643
- }
2644
- },
2645
- "parameters" : {
2646
- "rootCategoryIds" : {
2647
- "name" : "rootCategoryIds",
2648
- "in" : "query",
2649
- "description" : "IDs of the Knowledge Base root categories that must be considered",
2650
- "required" : false,
2651
- "style" : "simple",
2652
- "explode" : true,
2653
- "schema" : {
2654
- "type" : [ "null", "array" ],
2655
- "description" : "IDs of the Knowledge Base root categories that must be considered",
2656
- "items" : {
2657
- "type" : [ "string", "null", "integer" ],
2658
- "format" : "int64",
2659
- "pattern" : "([0-9]+)",
2660
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "IDs of the Knowledge Base root categories that must be considered", false, 10, ",", false, false, "0,5", false, false ]
2661
- },
2662
- "maxItems" : 10,
2663
- "minItems" : 1,
2664
- "uniqueItems" : false
2665
- }
2666
- },
2667
- "limit" : {
2668
- "name" : "limit",
2669
- "in" : "query",
2670
- "description" : "Number of trend-related records to list. The default value is 1000 and the maximum value allowed is 18000.",
2671
- "required" : false,
2672
- "style" : "form",
2673
- "explode" : true,
2674
- "schema" : {
2675
- "type" : [ "string", "null", "integer" ],
2676
- "format" : "int32",
2677
- "description" : "Number of trend-related records to list. The default value is 1000 and the maximum value allowed is 18000.",
2678
- "maximum" : 10000,
2679
- "pattern" : "([0-9]+)"
2680
- }
2681
- },
2682
- "articleId" : {
2683
- "name" : "articleId",
2684
- "in" : "path",
2685
- "description" : "",
2686
- "required" : true,
2687
- "style" : "simple",
2688
- "explode" : false,
2689
- "schema" : {
2690
- "type" : [ "string", "null", "integer" ],
2691
- "format" : "int64",
2692
- "description" : "",
2693
- "pattern" : "([0-9]+)"
2694
- }
2695
- },
2696
- "action" : {
2697
- "name" : "action",
2698
- "in" : "query",
2699
- "description" : "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT,@! !@TEMPLATE_USAGE@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.",
2700
- "required" : false,
2701
- "style" : "simple",
2702
- "explode" : true,
2703
- "schema" : {
2704
- "type" : [ "null", "array" ],
2705
- "description" : "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT,@! !@TEMPLATE_USAGE@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.",
2706
- "items" : {
2707
- "type" : [ "string", "null" ],
2708
- "description" : "",
2709
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "FEEDBACK", "TEMPLATE_USAGE" ],
2710
- "maxLength" : 100,
2711
- "minLength" : 0,
2712
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "User action whose trend-related records must be fetched. Values allowed are: !@LIKE,@! !@TEMPLATE_USAGE,@! !@DISLIKE,@! !@VIEW,@! !@TICKET_USAGE,@! !@COMMENT@! and !@FEEDBACK@!. If you do not pass a value, all actions are included.", false, 10, ",", false, false, "0,5", false, false ]
2713
- },
2714
- "maxItems" : 6,
2715
- "uniqueItems" : false
2716
- }
2717
- },
2718
- "from" : {
2719
- "name" : "from",
2720
- "in" : "query",
2721
- "description" : "Index number, starting from which the trend-related records must be fetched. The default value is 1.",
2722
- "required" : false,
2723
- "style" : "form",
2724
- "explode" : true,
2725
- "schema" : {
2726
- "type" : [ "string", "null", "integer" ],
2727
- "format" : "int32",
2728
- "description" : "Index number, starting from which the trend-related records must be fetched. The default value is 1.",
2729
- "pattern" : "([0-9]+)"
2730
- }
2731
- },
2732
- "departmentIds" : {
2733
- "name" : "departmentIds",
2734
- "in" : "query",
2735
- "description" : "IDs of the departments that must be considered",
2736
- "required" : false,
2737
- "style" : "simple",
2738
- "explode" : true,
2739
- "schema" : {
2740
- "type" : [ "null", "array" ],
2741
- "description" : "IDs of the departments that must be considered",
2742
- "items" : {
2743
- "type" : [ "string", "null", "integer" ],
2744
- "format" : "int64",
2745
- "pattern" : "([0-9]+)",
2746
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "IDs of the departments that must be considered", false, 10, ",", false, false, "0,5", false, false ]
2747
- },
2748
- "maxItems" : 10,
2749
- "minItems" : 1,
2750
- "uniqueItems" : false
2751
- }
2752
- },
2753
- "userType" : {
2754
- "name" : "userType",
2755
- "in" : "query",
2756
- "description" : " Type of users. Values allowed are: AGENTS, REGISTERED_USERS, PUBLIC_USERS, END_USERS and ALL_USERS (default).",
2757
- "required" : false,
2758
- "style" : "form",
2759
- "explode" : true,
2760
- "schema" : {
2761
- "type" : [ "string", "null" ],
2762
- "description" : " Type of users. Values allowed are: AGENTS, REGISTERED_USERS, PUBLIC_USERS, END_USERS and ALL_USERS (default).",
2763
- "enum" : [ "AGENTS", "REGISTERED_USERS", "PUBLIC_USERS", "END_USERS", "ALL_USERS" ],
2764
- "maxLength" : 100,
2765
- "minLength" : 0
2766
- }
2767
- },
2768
- "locale" : {
2769
- "name" : "locale",
2770
- "in" : "query",
2771
- "description" : "Language that must be considered",
2772
- "required" : false,
2773
- "style" : "form",
2774
- "explode" : true,
2775
- "schema" : {
2776
- "type" : [ "string", "null" ],
2777
- "description" : "Language that must be considered",
2778
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2779
- "maxLength" : 100,
2780
- "minLength" : 0,
2781
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2782
- }
2783
- },
2784
- "helpcenterIds" : {
2785
- "name" : "helpcenterIds",
2786
- "in" : "query",
2787
- "description" : "IDs of the help centers that must be considered.",
2788
- "required" : false,
2789
- "style" : "simple",
2790
- "explode" : true,
2791
- "schema" : {
2792
- "type" : [ "null", "array" ],
2793
- "description" : "IDs of the help centers that must be considered.",
2794
- "items" : {
2795
- "type" : [ "string", "null", "integer" ],
2796
- "format" : "int64",
2797
- "pattern" : "([0-9]+)",
2798
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "IDs of the help centers that must be considered.", false, 10, ",", false, false, "0,5", false, false ]
2799
- },
2800
- "maxItems" : 20,
2801
- "minItems" : 0,
2802
- "uniqueItems" : false
2803
- }
2804
- },
2805
- "timeRange" : {
2806
- "name" : "timeRange",
2807
- "in" : "query",
2808
- "description" : "Period in which the statistics were recorded. Values allowed are: LAST_24_HRS, LAST_7_DAYS, LAST_30_DAYS, LAST_365_DAYS, and yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ",
2809
- "required" : false,
2810
- "style" : "form",
2811
- "explode" : true,
2812
- "schema" : {
2813
- "type" : [ "string", "null" ],
2814
- "description" : "Period in which the statistics were recorded. Values allowed are: LAST_24_HRS, LAST_7_DAYS, LAST_30_DAYS, LAST_365_DAYS, and yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ",
2815
- "enum" : [ "LAST_24_HRS", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_365_DAYS" ],
2816
- "maxLength" : 100,
2817
- "minLength" : 0
2818
- }
2819
- },
2820
- "actionSource" : {
2821
- "name" : "actionSource",
2822
- "in" : "query",
2823
- "description" : "Channel/medium in which the action was performed. Values allowed are: !@API,@! !@HELPCENTER,@! !@ASAP_WEB,@! !@ASAP_ANDROID,@! !@ASAP_IOS@! and !@AGENT_VIEW@!. If you do not pass a value, all sources are included.",
2824
- "required" : false,
2825
- "style" : "simple",
2826
- "explode" : true,
2827
- "schema" : {
2828
- "type" : [ "null", "array" ],
2829
- "description" : "Channel/medium in which the action was performed. Values allowed are: !@API,@! !@HELPCENTER,@! !@ASAP_WEB,@! !@ASAP_ANDROID,@! !@ASAP_IOS@! and !@AGENT_VIEW@!. If you do not pass a value, all sources are included.",
2830
- "items" : {
2831
- "type" : [ "string", "null" ],
2832
- "description" : "",
2833
- "enum" : [ "API", "HELPCENTER", "ASAP_WEB", "ASAP_ANDROID", "ASAP_IOS", "AGENT_VIEW" ],
2834
- "maxLength" : 100,
2835
- "minLength" : 0,
2836
- "x-custom-parameters-attributes" : [ false, false, false, "", false, "Channel/medium in which the action was performed. Values allowed are: !@API,@! !@HELPCENTER,@! !@ASAP_WEB,@! !@ASAP_ANDROID,@! !@ASAP_IOS@! and !@AGENT_VIEW@!. If you do not pass a value, all sources are included.", false, 10, ",", false, false, "0,5", false, false ]
2837
- },
2838
- "maxItems" : 6,
2839
- "uniqueItems" : false
2840
- }
2841
- }
2842
- },
2843
- "requestBodies" : {
2844
- "metricsResetPayload" : {
2845
- "content" : {
2846
- "application/json" : {
2847
- "schema" : {
2848
- "type" : [ "null", "object" ],
2849
- "additionalProperties" : false,
2850
- "properties" : {
2851
- "action" : {
2852
- "$ref" : "./ArticleStatistics.json#/components/schemas/actionArray"
2853
- }
2854
- },
2855
- "required" : [ "action" ]
2856
- },
2857
- "examples" : {
2858
- "Valid requestBody Definitions" : {
2859
- "value" : {
2860
- "action" : [ "VIEW", "FEEDBACK" ]
2861
- }
2862
- }
2863
- }
2864
- }
2865
- },
2866
- "x-custom-request-body-attributes" : {
2867
- "non-empty" : false,
2868
- "allow-invalid" : false
2869
- }
2870
- },
2871
- "resetArticleMetrics_metricsResetPayload" : {
2872
- "content" : {
2873
- "application/json" : {
2874
- "schema" : {
2875
- "type" : [ "null", "object" ],
2876
- "additionalProperties" : false,
2877
- "properties" : {
2878
- "action" : {
2879
- "$ref" : "./ArticleStatistics.json#/components/schemas/actionArray"
2880
- }
2881
- },
2882
- "required" : [ "action" ]
2883
- },
2884
- "examples" : {
2885
- "Valid requestBody Definitions" : {
2886
- "value" : {
2887
- "action" : [ "VIEW" ]
2888
- }
2889
- }
2890
- }
2891
- }
2892
- },
2893
- "x-custom-request-body-attributes" : {
2894
- "non-empty" : false,
2895
- "allow-invalid" : false
2896
- }
2897
- },
2898
- "reportGenerationPayload" : {
2899
- "content" : {
2900
- "application/json" : {
2901
- "schema" : {
2902
- "type" : [ "null", "object" ],
2903
- "additionalProperties" : false,
2904
- "properties" : {
2905
- "rootCategoryIds" : {
2906
- "$ref" : "./ArticleStatistics.json#/components/schemas/rootCategoryIds"
2907
- },
2908
- "action" : {
2909
- "type" : [ "string", "null" ],
2910
- "description" : "User action that must be considered for the report. Values allowed are: LIKE, DISLIKE, VIEW, TICKET_USAGE, COMMENT, and FEEDBACK.",
2911
- "enum" : [ "LIKE", "DISLIKE", "VIEW", "COMMENT", "TICKET_USAGE", "FEEDBACK", "TEMPLATE_USAGE" ],
2912
- "maxLength" : 100,
2913
- "minLength" : 0
2914
- },
2915
- "departmentIds" : {
2916
- "$ref" : "./ArticleStatistics.json#/components/schemas/departmentIds"
2917
- },
2918
- "locale" : {
2919
- "type" : [ "string", "null" ],
2920
- "description" : "Language of the help articles",
2921
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2922
- "maxLength" : 100,
2923
- "minLength" : 0,
2924
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2925
- },
2926
- "timeRange" : {
2927
- "type" : [ "string", "null" ],
2928
- "description" : "Period in which the user actions were performed. Values allowed are: LAST_24_HRS, LAST_7_DAYS (default value), LAST_30_DAYS, and LAST_365_DAYS.",
2929
- "enum" : [ "LAST_24_HRS", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_365_DAYS" ],
2930
- "maxLength" : 100,
2931
- "minLength" : 0
2932
- }
2933
- },
2934
- "required" : [ "action", "locale", "rootCategoryIds", "timeRange" ]
2935
- },
2936
- "examples" : {
2937
- "Valid requestBody Definitions" : {
2938
- "value" : {
2939
- "action" : "FEEDBACK",
2940
- "departmentIds" : [ "1000000013248" ],
2941
- "locale" : "en",
2942
- "timeRange" : "LAST_365_DAYS"
2943
- }
2944
- }
2945
- }
2946
- }
2947
- },
2948
- "x-custom-request-body-attributes" : {
2949
- "non-empty" : false,
2950
- "allow-invalid" : false
2951
- }
2952
- },
2953
- "metricsUpdatePayload" : {
2954
- "content" : {
2955
- "application/json" : {
2956
- "schema" : {
2957
- "type" : [ "null", "object" ],
2958
- "additionalProperties" : false,
2959
- "properties" : {
2960
- "action" : {
2961
- "$ref" : "./ArticleStatistics.json#/components/schemas/actionArray"
2962
- },
2963
- "userType" : {
2964
- "type" : [ "string", "null" ],
2965
- "description" : "Type of users whose metrics must be updated. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS,@! !@PUBLIC_USERS,@! !@END_USERS@! and !@ALL_USERS@!.",
2966
- "enum" : [ "AGENTS", "REGISTERED_USERS", "PUBLIC_USERS", "END_USERS", "ALL_USERS" ],
2967
- "maxLength" : 100,
2968
- "minLength" : 0
2969
- },
2970
- "timeRange" : {
2971
- "type" : [ "string", "null" ],
2972
- "description" : "Key that filters metrics added within a specific date and time range. Enter the time range in the formats of: !@LAST_24_HRS,@! !@LAST_7_DAYS,@! !@LAST_30_DAYS,@! !@LAST_365_DAYS@! and !@yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ@!",
2973
- "enum" : [ "LAST_24_HRS", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_365_DAYS" ],
2974
- "maxLength" : 100,
2975
- "minLength" : 0
2976
- }
2977
- },
2978
- "required" : [ "action", "timeRange", "userType" ]
2979
- },
2980
- "examples" : {
2981
- "Valid requestBody Definitions" : {
2982
- "value" : {
2983
- "action" : [ "COMMENT", "DISLIKE" ],
2984
- "userType" : "ALL_USERS",
2985
- "timeRange" : "LAST_7_DAYS"
2986
- }
2987
- }
2988
- }
2989
- }
2990
- },
2991
- "x-custom-request-body-attributes" : {
2992
- "non-empty" : false,
2993
- "allow-invalid" : false
2994
- }
2995
- },
2996
- "updateArticleTranslationMetrics_metricsUpdatePayload" : {
2997
- "content" : {
2998
- "application/json" : {
2999
- "schema" : {
3000
- "type" : [ "null", "object" ],
3001
- "additionalProperties" : false,
3002
- "properties" : {
3003
- "action" : {
3004
- "$ref" : "./ArticleStatistics.json#/components/schemas/actionArray"
3005
- },
3006
- "userType" : {
3007
- "type" : [ "string", "null" ],
3008
- "description" : "Type of users whose metrics must be updated. Values allowed are: !@AGENTS,@! !@REGISTERED_USERS,@! !@PUBLIC_USERS,@! !@END_USERS@! and !@ALL_USERS@!.",
3009
- "enum" : [ "AGENTS", "REGISTERED_USERS", "PUBLIC_USERS", "END_USERS", "ALL_USERS" ],
3010
- "maxLength" : 100,
3011
- "minLength" : 0
3012
- },
3013
- "timeRange" : {
3014
- "type" : [ "string", "null" ],
3015
- "description" : "Key that filters metrics added within a specific date and time range. Enter the time range in the formats of: !@LAST_24_HRS,@! !@LAST_7_DAYS,@! !@LAST_30_DAYS,@! !@LAST_365_DAYS@! and !@yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ@!",
3016
- "enum" : [ "LAST_24_HRS", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_365_DAYS" ],
3017
- "maxLength" : 100,
3018
- "minLength" : 0
3019
- }
3020
- },
3021
- "required" : [ "action", "timeRange", "userType" ]
3022
- },
3023
- "examples" : {
3024
- "Valid requestBody Definitions" : {
3025
- "value" : {
3026
- "action" : [ "COMMENT", "DISLIKE" ],
3027
- "userType" : "PUBLIC_USERS",
3028
- "timeRange" : "LAST_7_DAYS"
3029
- }
3030
- }
3031
- }
3032
- }
3033
- },
3034
- "x-custom-request-body-attributes" : {
3035
- "non-empty" : false,
3036
- "allow-invalid" : false
3037
- }
3038
- }
3039
- },
3040
- "securitySchemes" : {
3041
- "cookie-auth" : {
3042
- "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
3043
- },
3044
- "org-oauth" : {
3045
- "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
3046
- },
3047
- "iam-oauth2-schema" : {
3048
- "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
3049
- }
3050
- }
3051
- },
3052
- "x-entity" : "ArticleStatistics"
3053
- }