{"type":"api","title":"Get Landing Dashboard Top N Analytics","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/04a747ed-d1dc-3e58-b0f2-037004d279a6","info":{"contact":{"name":"API Support","url":"https://devnetapps.cisco.com/docs/nexus-dashboard/api-v1/developer-support/"},"description":"Nexus Dashboard Fabric Controller API - SAN","title":"Nexus Dashboard Fabric Controller API - SAN","version":"12.5.0"},"tags":[{"name":"Features"},{"name":"Templates"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-legacy-san.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.1","servers":[{"url":"/appcenter/cisco/ndfc/api/v1/","description":"Test server"}]},"spec":{"tags":["SAN Analytics UI"],"summary":"Get the graph data for the Top 10 Host/Storage graph for either SCSI or NVMe by Enclosure, WWN or Device Alias","operationId":"getLandingDashboardTopNAnalytics","parameters":[{"name":"queryScope","in":"query","description":"Query Scope. \n\n Only four value are allowed DC|FabricDBID|Fabric|Switch \n\n DC stands for DataCenter and it is the largest Scope.","required":true,"schema":{"type":"string"},"example":"DC"},{"name":"queryScopeID","in":"query","description":"Query Scope ID. \n\nThis goes with the queryScope parameter and possible values are null|FabricDBID DbID|Fabric fid|Switch IP. \n\nIf the queryScope = DC then queryScopeID is null, \n\n if the queryScope = FabricDBID then the queryScopeID is that fabric DBID number,\n\nif the queryScope = Fabric then the queryScopeID is the fabric fid number, \n\n if the queryScope = Switch then the queryScopeID is Switch IP.","required":true,"schema":{"type":"string"},"example":null},{"name":"queryType","in":"query","description":"Type of Query. \n\n This value tells us if this is for SCSI/NVMe (by default the query is for SCSI so for NVMe you include a prefix), Host/Storage, for IOPS/DAL/AvgECT/AvgIOT, for read/write and for Enc/WWN/Alias. \n\n As such the value is a composite of those i.e. (''/nvme_)+(host/storage)+(IOPS/DAL/AvgECT/AvgIOT)+(read/write)+(Enc/WWN/Alias) \n\nso an example value would be hostIOPSreadEnc or nvme_hostIOPSreadEnc","required":true,"schema":{"type":"string"},"example":"hostIOPSreadEnc"},{"name":"clientRequestId","in":"query","description":"Client request number, this is for client use to match request with response. The response simply echos the value back in the response.","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"clientRequestId":{"type":"integer","format":"int32"},"queryScope":{"type":"string"},"queryScopeID":{"type":"string"},"queryType":{"type":"string"},"readData":{"type":"array","items":{"type":"object","properties":{"sum":{"type":"number"},"timestamp":{"type":"integer","format":"int64"},"timestampStr":{"type":"string"}},"$$ref":"#/components/schemas/LDashboardAnalyticsDO"}},"writeData":{"type":"array","items":{"type":"object","properties":{"sum":{"type":"number"},"timestamp":{"type":"integer","format":"int64"},"timestampStr":{"type":"string"}},"$$ref":"#/components/schemas/LDashboardAnalyticsDO"}},"getxLabels":{"type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/LDashboardAnalyticsContainerDO"}}}}},"__originalOperationId":"getLandingDashboardTopNAnalytics","method":"get","path":"/appcenter/cisco/ndfc/api/v1/san-insight/sanAnalytics/getLandingDashboardTopNAnalytics"}}