{"type":"api","title":"Get Task History","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get all the auto on tasks","operationId":"getTaskHistory","parameters":[{"name":"startTime","in":"query","description":"query start time","schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"query end time","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int32"},"events":{"type":"array","items":{"type":"string"}},"expire-time":{"type":"integer","format":"int32"},"sites":{"type":"array","items":{"type":"string"}},"state":{"type":"string"},"taskId":{"type":"integer","format":"int32"},"taskName":{"type":"string"},"traces":{"type":"boolean"},"type":{"type":"string"}},"$$ref":"#/components/schemas/TaskHistoryResponsePayloadData"}}},"description":"Auto on task schema for GET response","$$ref":"#/components/schemas/TaskHistoryResponsePayload"},"examples":{"Response for getting tasks":{"description":"Response for getting tasks","value":{"header":{"generatedOn":1716795499234,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-nwpiTaskData"},"columns":[{"title":"Task Name","property":"taskName","dataType":"string"},{"title":"Task ID","property":"taskId","dataType":"number"},{"title":"Event(s)","property":"events","dataType":"array"},{"title":"Site(s)","property":"sites","dataType":"array"},{"title":"State","property":"state","dataType":"string"},{"title":"Start Time","property":"startTime","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"},{"title":"Duration","property":"duration","dataType":"string"},{"title":"Stop Time","property":"stopTime","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"}],"fields":[{"property":"taskName","dataType":"string"},{"property":"taskId","dataType":"number"},{"property":"events","dataType":"array"},{"property":"sites","dataType":"array"},{"property":"state","dataType":"string"},{"property":"startTime","dataType":"date"},{"property":"duration","dataType":"string"},{"property":"stopTime","dataType":"date"},{"property":"data","dataType":"object"}]},"data":[{"taskId":4,"taskName":"auto_on","duration":"600","events":["qos-congestion","sla-violation"],"sites":["100","500"],"sitesName":["SITE_100","SITE_500"],"stopTime":1716831311226,"traces":false,"startTime":1716795311226,"entry_time":1716795311226,"state":"active","type":"task-history","insertTime":1716795499234},{"startTime":1716795211822,"taskId":3,"taskName":"auto_on","duration":"1440","events":["qos-congestion","sla-violation"],"sites":["100","500"],"sitesName":["SITE_100","SITE_500"],"stopTime":1716795289048,"traces":"false","state":"finished","type":"task-history","tenant":"default"},{"startTime":1716443790022,"taskId":1,"taskName":"auto-on","duration":"1440","events":["qos-congestion","sla-violation"],"sites":["100","400","500","600"],"sitesName":["SITE_100","SITE_400","SITE_500","SITE_600"],"stopTime":1716530190022,"traces":"true","state":"finished","type":"task-history","tenant":"default"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write","method":"get","path":"/stream/device/nwpi/tasks/taskHistory"}}