{"type":"api","title":"Get Top N analytics data of issues","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getTopNAnalyticsDataOfIssues","tags":["Issues"],"deprecated":false,"summary":"Get Top N analytics data of issues","description":"Gets the Top N analytics data related to issues based on given filters and group by field. This data can be used to find top sites which has most issues or top device types with most issue etc,. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-IssuesList-1.0.1-resolved.yaml","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"Accept-Language","description":"This header parameter can be used to specify the language in which issue display name need to be returned. Available options are - 'en' (English), 'ja' (Japanese), 'ko' (Korean), 'zh' (Chinese). If this parameter is not present the issue display name is returned in English language.","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"X-CALLER-ID","description":"Caller ID can be used to trace the caller for queries executed on database. The caller id is like a optional attribute which can be added to API invocation like ui, python, postman, test-automation etc","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"type":"integer","description":""},"endTime":{"type":"integer","description":""},"topN":{"type":"integer","description":""},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"operator":{"type":"string","description":""},"value":{"type":"string","description":""},"logicalOperator":{"type":"string","description":""},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"operator":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":""}}},"description":""},"groupBy":{"type":"array","items":{"type":"string"},"description":""},"attributes":{"type":"array","items":{"type":"string"},"description":""},"aggregateAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"function":{"type":"string","description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"integer","description":""},"sortBy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"order":{"type":"string","description":""}}},"description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/GetTopNAnalyticsDataOfIssuesRequest"}}},"required":true},"responses":{"200":{"description":"Issues Top N Analytics Response","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","description":""},"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":""},"aggregateAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"function":{"type":"string","description":""},"value":{"type":"integer","description":""}}},"description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"integer","description":""},"count":{"type":"integer","description":""},"sortBy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"function":{"type":"object","properties":{},"description":""},"order":{"type":"string","description":""}}},"description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/GetTopNAnalyticsDataOfIssuesResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}}},"x-rapi-id":"21a7-c91a-4f5a-b54d","x-rapi-overview":"Gets the Top N analytics data related to issues based on given filters and group by field. This data can be used to find top sites which has most issues or top device types with most issue etc,. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-IssuesList-1.0.1-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Issues","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/issues/topNAnalytics","x-rapi-publicPath":"/dna/data/api/v1/assuranceIssues/topNAnalytics","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"25~MINUTE","__originalOperationId":"getTopNAnalyticsDataOfIssues","method":"post","path":"/dna/data/api/v1/assuranceIssues/topNAnalytics"}}