URL : v3/api/agent/report/export/download/{hash} Method : GET Segment: Parameter Type Optional/Required Description hash string Required Report hash. Available in Report Export List API Parameters: none Response: HTTP file resource
Articles Tagged: v3
Report Exports Delete
URL : v3/api/agent/report/export/delete/{id} Method : DELETE Segment: Parameter Type Optional/Required Description id integer Required Report id. Available in Report Export List API Parameters: none Response: { “success”: true, “message”: “Report removed successfully” }
Get exception logs
URL: v3/api/logs/exception Method: GET Description : Gets the list of logs Parameters: Parameter Type Optional/Required Description search_query string Optional String that has to be searched sort_order string Optional Sort order `asc` or `desc` sort_field string Optional Field by which results has to be sorted limit string Optional Count of results that are required category_ids array […]
Get cron logs
URL: v3/api/logs/cron Method: GET Description : Gets the list of logs Parameters: Parameter Type Optional/Required Description search_query string Optional String that has to be searched sort_order string Optional Sort order `asc` or `desc` sort_field string Optional Field by which results has to be sorted limit string Optional Count of results that are required category_ids array […]
Get mail logs
URL: v3/api/logs/mail Method: GET Description : Gets the list of logs Parameters: Parameter Type Optional/Required Description search_query string Optional String that has to be searched sort_order string Optional Sort order `asc` or `desc` sort_field string Optional Field by which results has to be sorted limit string Optional Count of results that are required category_ids string […]
Get Log Category List
URL: v3/api/log-category-list Method: GET Description : Gets the list of log categories Parameters: Parameter Type Optional/Required Description search_query string Optional String that has to be searched limit string Optional Count of results that are required Response: { “success”:true, “data”:{ “log_categories”: [{ “id”:1, “name”:”ticket-create” }, { “id”:2, “name”:”user-create” }, { “id”:3, “name”:”mail-fetch” }, { “id”:4, […]
Get Mail Body
URL: v3/api/get-log-mail-body/{logId} Method: GET Description : Gets mail body Response: { “success”:true, “data”:{ “mail_body”:”test_body” } }
Delete Logs
URL: v3/api/delete-logs Method: DELETE Description : Deletes logs by category Parameters: Parameter Type Optional/Required Description categories array Required Array of logs that has to be deleted. Following are the keys : mail, cron, exception. For eg. [ ‘cron’, ‘exception’] for deleting cron-logs and exception logs delete_before string Optional The time before all logs should be […]
Approval Workflow List
URL : v3/api/admin/approval-workflow Method : GET Parameters: Parameter Type Optional/Required Description limit integer Optional Records per page page integer Optional Page number sort_by string Optional Order by column. Valid inputs: name, created_at and updated_at order string Optional Order of sorting. Valid inputs: asc & desc search string Optional Search string restricted boolean Optional To restrict […]
Approval Workflow Show
URL : v3/api/admin/approval-workflow/{id} Method : GET Segment: Parameter Type Optional/Required Description id Integer Required Approval workflow id. Parameters: none Response: { “success”: true, “data”: { “id”: 52, “name”: “Omnis iure minima fugiat qui odit eligendi sit quo.”, “user_id”: 173, “levels”: [{ “id”: 52, “name”: “Level 1”, “match”: […]