Get Epoch Summary For Single Epoch - Nexus Dashboard API v1, Release 4.2 and above

{"type":"api","title":"Get Epoch Summary For Single Epoch","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/65a171d6-461c-341f-833b-8723fe3ac65c","info":{"contact":{"name":"API Support","url":"https://devnetapps.cisco.com/docs/nexus-dashboard/api-v1/developer-support/"},"description":"Nexus Dashboard Insights API Documentation","title":"Nexus Dashboard Insights API","version":"6.8.0"},"tags":[{"name":"Cloud"},{"name":"Anomaly Threshold settings"},{"name":"Cluster level settings"},{"name":"Config - NI"},{"name":"NI Systems Settings"},{"name":"Site - Alert Rules"},{"name":"Site - Collection"},{"name":"Site - Compliance Requirements"},{"name":"Site - Configuration Import Export"},{"name":"Site - Entity Settings, Offline / Epoch-Delta Jobs & Site Management"},{"name":"Site - Export Kafka Fast Settings"},{"name":"Site - Export Nas Settings"},{"name":"Site - Export Settings"},{"name":"Site - FileUpload"},{"name":"Site - Flow Rules"},{"name":"Site - Integrations"},{"name":"Site - Offline Data Collection"},{"name":"Site - PDU integration"},{"name":"Site - Pre-Change Analysis"},{"name":"Site - Purge Epoch & Anomaly DB"},{"name":"Site - Syslog Export Settings"},{"name":"Site Group"},{"name":"Site Groups"},{"name":"Traffic Analytics Rules settings"},{"name":"User Settings"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-legacy-insights.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.3","servers":[{"url":"/"}]},"spec":{"operationId":"getEpochSummaryForSingleEpoch","parameters":[{"in":"path","name":"insightsGroup","required":true,"schema":{"type":"string"}},{"in":"path","name":"fabricName","required":true,"schema":{"type":"string"}},{"description":"A string variable which represents id of the epoch. The value $latest can be provided in order to return the latest epoch.","in":"path","name":"uuid","required":true,"schema":{"type":"string"}},{"in":"query","name":"showMyEventsCount","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"analysisCompletionTimeMsecs":3,"analysisStartTimeMsecs":4,"fabricId":"fabricId","exportState":"NOT_EXPORTED","importState":"GENERATED","applianceVersion":"applianceVersion","epochType":"ONLINE","offlineAnalysisId":"offlineAnalysisId","analysisCompletionTimeRfc3339":"analysisCompletionTimeRfc3339","esIndexerStatus":"INDEX_NOT_DONE","links":{"empty":true},"collectionTimeRfc3339":"collectionTimeRfc3339","microserviceStatus":[{"tasksCompleted":1,"microservice":"UCS","dataSizeBytes":5,"totalTasks":5},{"tasksCompleted":1,"microservice":"UCS","dataSizeBytes":5,"totalTasks":5}],"assuranceInfo":[{"severity":"severity","count":0,"links":{"empty":true}},{"severity":"severity","count":0,"links":{"empty":true}}],"pcvJobName":"pcvJobName","collectionTimeMsecs":9,"globalSearchResultsExist":true,"windowId":2,"processed":true,"eventInfo":[{"severity":"severity","count":2,"links":{"empty":true}},{"severity":"severity","count":2,"links":{"empty":true}}],"leafCount":7,"msoAciEpochList":[null,null],"analysisStartTimeRfc3339":"analysisStartTimeRfc3339","siteId":"siteId","isOffline":true,"epochId":"epochId","criticalEventCount":6,"collectorDataStatus":"ALL_PRESENT","analysisUuid":"analysisUuid","applicationId":"applicationId","status":"IN_PROGRESS","fabricName":"fabricName"},"properties":{"assuranceInfo":{"description":"Assurance entity info","items":{"example":{"severity":"severity","count":0,"links":{"empty":true}},"properties":{"severity":{"description":"Event severity","type":"string"},"count":{"description":"Total event count","format":"int64","type":"integer"},"links":{"example":{"empty":true},"properties":{"empty":{"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/Links"}},"type":"object","$$ref":"#/components/schemas/AssuranceInfoDto"},"type":"array"},"status":{"description":"Epoch status","enum":["IN_PROGRESS","FINISHED","FAILED","DELETING","PARTIALLY_FAILED"],"type":"string"},"collectionTimeRfc3339":{"description":"Collection time in RFC 3339 format","type":"string"},"analysisStartTimeRfc3339":{"description":"Epoch assurance analysis start time in RFC 3339 format","type":"string"},"applianceVersion":{"description":"Appliance version","type":"string"},"isOffline":{"description":"Checks if epoch is offline","type":"boolean"},"criticalEventCount":{"description":"Critical event count","format":"int64","type":"integer"},"microserviceStatus":{"description":"Microservice status","items":{"example":{"tasksCompleted":1,"microservice":"UCS","dataSizeBytes":5,"totalTasks":5},"properties":{"microservice":{"description":"MicroService dto","enum":["UCS","POLICY","ROUTING_TENANT_CHECKER","ROUTING_EP_CHECKER","ROUTING_LOGICAL_PARSER","ROUTING_CONCRETE_PARSER","VM_NETWORKING_LOGICAL_PARSER","ROUTING_MPBGP_CHECKER","ROUTING_RIB_RNH_OPERATOR","ROUTING_RIB_FIB_EQUIVALENCE","ROUTING_INFRA_CHECKER","ROUTING_GRAPH_CHECKER"],"type":"string"},"tasksCompleted":{"description":"Tasks completed","format":"int32","type":"integer"},"totalTasks":{"description":"Total tasks","format":"int32","type":"integer"},"dataSizeBytes":{"description":"Data size in bytes","format":"int64","type":"integer"}},"type":"object","$$ref":"#/components/schemas/EpochStatusDto"},"type":"array"},"eventInfo":{"description":"Represents event information","items":{"example":{"severity":"severity","count":2,"links":{"empty":true}},"properties":{"severity":{"description":"Event severity","type":"string"},"count":{"description":"Total event count","format":"int64","type":"integer"},"links":{"example":{"empty":true},"properties":{"empty":{"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/Links"}},"type":"object","$$ref":"#/components/schemas/EventSeverityDto"},"type":"array"},"esIndexerStatus":{"description":"Es indexer status","enum":["INDEX_NOT_DONE","INDEX_STARTED","INDEX_IN_PROGRESS","INDEX_FLUSHING","INDEX_AT_ELASTIC","INDEX_PARTIAL","INDEX_COMPLETED","INDEX_FAILED","INDEX_TIMEDOUT"],"type":"string"},"epochType":{"description":"Epoch type","enum":["ONLINE","OFFLINE","PCV"],"type":"string"},"pcvJobName":{"description":"Pcv job name","type":"string"},"leafCount":{"description":"Total leaf count","format":"int32","type":"integer"},"importState":{"description":"Import state","enum":["GENERATED","IMPORTED"],"type":"string"},"exportState":{"description":"Export state","enum":["NOT_EXPORTED","EXPORT_SUCCEEDED","EXPORT_FAILED"],"type":"string"},"collectorDataStatus":{"description":"Collector data status","enum":["ALL_PRESENT","CONCRETE_AND_HARDWARE_REMOVED"],"type":"string"},"globalSearchResultsExist":{"description":"Checks if global search results exists","type":"boolean"},"links":{"example":{"empty":true},"properties":{"empty":{"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/Links"},"collectionTimeMsecs":{"description":"Epoch collection timestamp","format":"int64","type":"integer"},"analysisCompletionTimeMsecs":{"description":"Timstamp when epoch was processed","format":"int64","type":"integer"},"analysisCompletionTimeRfc3339":{"description":"Epochs process timestamp in RFC 3339 format","type":"string"},"fabricId":{"description":"Fabric uuid","type":"string"},"fabricName":{"type":"string"},"msoAciEpochList":{"items":{"$ref":"#/components/schemas/NbEpochDto","$$ref":"#/components/schemas/NbEpochDto"},"readOnly":true,"type":"array"},"siteId":{"description":"Site uuid","type":"string"},"epochId":{"description":"uuid","type":"string"},"windowId":{"description":"Window id","format":"int64","type":"integer"},"processed":{"description":"Boolean to represent if Epoch is processed","type":"boolean"},"analysisStartTimeMsecs":{"description":"Timestamp when epoch process was started","format":"int64","type":"integer"},"offlineAnalysisId":{"description":"Offline assurance analysis uuid","type":"string"},"analysisUuid":{"description":"Analysis uuid","type":"string"},"applicationId":{"description":"Application id","type":"string"}},"type":"object","$$ref":"#/components/schemas/NbEpochDto"}},"application/xml":{"schema":{"example":{"analysisCompletionTimeMsecs":3,"analysisStartTimeMsecs":4,"fabricId":"fabricId","exportState":"NOT_EXPORTED","importState":"GENERATED","applianceVersion":"applianceVersion","epochType":"ONLINE","offlineAnalysisId":"offlineAnalysisId","analysisCompletionTimeRfc3339":"analysisCompletionTimeRfc3339","esIndexerStatus":"INDEX_NOT_DONE","links":{"empty":true},"collectionTimeRfc3339":"collectionTimeRfc3339","microserviceStatus":[{"tasksCompleted":1,"microservice":"UCS","dataSizeBytes":5,"totalTasks":5},{"tasksCompleted":1,"microservice":"UCS","dataSizeBytes":5,"totalTasks":5}],"assuranceInfo":[{"severity":"severity","count":0,"links":{"empty":true}},{"severity":"severity","count":0,"links":{"empty":true}}],"pcvJobName":"pcvJobName","collectionTimeMsecs":9,"globalSearchResultsExist":true,"windowId":2,"processed":true,"eventInfo":[{"severity":"severity","count":2,"links":{"empty":true}},{"severity":"severity","count":2,"links":{"empty":true}}],"leafCount":7,"msoAciEpochList":[null,null],"analysisStartTimeRfc3339":"analysisStartTimeRfc3339","siteId":"siteId","isOffline":true,"epochId":"epochId","criticalEventCount":6,"collectorDataStatus":"ALL_PRESENT","analysisUuid":"analysisUuid","applicationId":"applicationId","status":"IN_PROGRESS","fabricName":"fabricName"},"properties":{"assuranceInfo":{"description":"Assurance entity info","items":{"example":{"severity":"severity","count":0,"links":{"empty":true}},"properties":{"severity":{"description":"Event severity","type":"string"},"count":{"description":"Total event count","format":"int64","type":"integer"},"links":{"example":{"empty":true},"properties":{"empty":{"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/Links"}},"type":"object","$$ref":"#/components/schemas/AssuranceInfoDto"},"type":"array"},"status":{"description":"Epoch status","enum":["IN_PROGRESS","FINISHED","FAILED","DELETING","PARTIALLY_FAILED"],"type":"string"},"collectionTimeRfc3339":{"description":"Collection time in RFC 3339 format","type":"string"},"analysisStartTimeRfc3339":{"description":"Epoch assurance analysis start time in RFC 3339 format","type":"string"},"applianceVersion":{"description":"Appliance version","type":"string"},"isOffline":{"description":"Checks if epoch is offline","type":"boolean"},"criticalEventCount":{"description":"Critical event count","format":"int64","type":"integer"},"microserviceStatus":{"description":"Microservice status","items":{"example":{"tasksCompleted":1,"microservice":"UCS","dataSizeBytes":5,"totalTasks":5},"properties":{"microservice":{"description":"MicroService dto","enum":["UCS","POLICY","ROUTING_TENANT_CHECKER","ROUTING_EP_CHECKER","ROUTING_LOGICAL_PARSER","ROUTING_CONCRETE_PARSER","VM_NETWORKING_LOGICAL_PARSER","ROUTING_MPBGP_CHECKER","ROUTING_RIB_RNH_OPERATOR","ROUTING_RIB_FIB_EQUIVALENCE","ROUTING_INFRA_CHECKER","ROUTING_GRAPH_CHECKER"],"type":"string"},"tasksCompleted":{"description":"Tasks completed","format":"int32","type":"integer"},"totalTasks":{"description":"Total tasks","format":"int32","type":"integer"},"dataSizeBytes":{"description":"Data size in bytes","format":"int64","type":"integer"}},"type":"object","$$ref":"#/components/schemas/EpochStatusDto"},"type":"array"},"eventInfo":{"description":"Represents event information","items":{"example":{"severity":"severity","count":2,"links":{"empty":true}},"properties":{"severity":{"description":"Event severity","type":"string"},"count":{"description":"Total event count","format":"int64","type":"integer"},"links":{"example":{"empty":true},"properties":{"empty":{"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/Links"}},"type":"object","$$ref":"#/components/schemas/EventSeverityDto"},"type":"array"},"esIndexerStatus":{"description":"Es indexer status","enum":["INDEX_NOT_DONE","INDEX_STARTED","INDEX_IN_PROGRESS","INDEX_FLUSHING","INDEX_AT_ELASTIC","INDEX_PARTIAL","INDEX_COMPLETED","INDEX_FAILED","INDEX_TIMEDOUT"],"type":"string"},"epochType":{"description":"Epoch type","enum":["ONLINE","OFFLINE","PCV"],"type":"string"},"pcvJobName":{"description":"Pcv job name","type":"string"},"leafCount":{"description":"Total leaf count","format":"int32","type":"integer"},"importState":{"description":"Import state","enum":["GENERATED","IMPORTED"],"type":"string"},"exportState":{"description":"Export state","enum":["NOT_EXPORTED","EXPORT_SUCCEEDED","EXPORT_FAILED"],"type":"string"},"collectorDataStatus":{"description":"Collector data status","enum":["ALL_PRESENT","CONCRETE_AND_HARDWARE_REMOVED"],"type":"string"},"globalSearchResultsExist":{"description":"Checks if global search results exists","type":"boolean"},"links":{"example":{"empty":true},"properties":{"empty":{"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/Links"},"collectionTimeMsecs":{"description":"Epoch collection timestamp","format":"int64","type":"integer"},"analysisCompletionTimeMsecs":{"description":"Timstamp when epoch was processed","format":"int64","type":"integer"},"analysisCompletionTimeRfc3339":{"description":"Epochs process timestamp in RFC 3339 format","type":"string"},"fabricId":{"description":"Fabric uuid","type":"string"},"fabricName":{"type":"string"},"msoAciEpochList":{"items":{"$ref":"#/components/schemas/NbEpochDto","$$ref":"#/components/schemas/NbEpochDto"},"readOnly":true,"type":"array"},"siteId":{"description":"Site uuid","type":"string"},"epochId":{"description":"uuid","type":"string"},"windowId":{"description":"Window id","format":"int64","type":"integer"},"processed":{"description":"Boolean to represent if Epoch is processed","type":"boolean"},"analysisStartTimeMsecs":{"description":"Timestamp when epoch process was started","format":"int64","type":"integer"},"offlineAnalysisId":{"description":"Offline assurance analysis uuid","type":"string"},"analysisUuid":{"description":"Analysis uuid","type":"string"},"applicationId":{"description":"Application id","type":"string"}},"type":"object","$$ref":"#/components/schemas/NbEpochDto"}}},"description":"message"}},"summary":"API to fetch epoch based on ID","__originalOperationId":"getEpochSummaryForSingleEpoch","method":"get","path":"/insightsGroup/{insightsGroup}/fabric/{fabricName}/epochs/{uuid}"}}