{"type":"api","title":"Get the activity count per protocol","meta":{"id":"/apps/pubhub/media/cyber-vision-5-3/e889ca86e22c7a47e33bc1438ffdba51f3384493/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"description":"RESTful API to manage the resources of Cisco Cyber Vision centers.","title":"Cisco Cyber Vision center v3 API.","version":"3.0.0-5.3.0"},"security":[{"token":[]}],"tags":[{"description":"Routes to configure the Active Discovery mode.","name":"ActiveDiscovery"},{"description":"Activities are an aggregation of flows between components.","name":"Activities"},{"description":"In monitor mode, these routes allow to retrieve and review differences between the actual network activity and the baseline description.","name":"BaselineDifferences"},{"description":"A baseline is used for monitor mode. They represent a snapshot of the network.","name":"Baselines"},{"description":"Components are logical nodes of the network.","name":"Components"},{"description":"Routes to manage network organization.","name":"CustomNetwork"},{"description":"Routes to manage custom properties that can be added to components or groups.","name":"CustomProperties"},{"description":"Routes to retrieve statistics and dashboard information. ","name":"Dashboard"},{"description":"Routes to retrieve information about the sensor deployment tokens.","name":"Deployments"},{"description":"A Device is a physical device that host a software that communicates on the network","name":"Devices"},{"description":"Routes to retrieve about external communications.","name":"ExternalCommunication"},{"description":"Flows represent a network interaction between two components.","name":"Flows"},{"description":"Routes to retrieve information about the global credentials.","name":"GlobalCredentials"},{"description":"Routes to get a graphical representation of the components, activities, etc.","name":"Graph"},{"description":"Groups are a logical way to organize components.","name":"Groups"},{"description":"Various routes to get more information about a center.","name":"Misc"},{"description":"Routes to access the application parameters such as security options and allow to manage custom parameters.","name":"Parameters"},{"description":"Routes to retrieve information about pcap files replayed.","name":"PcapReplays"},{"description":"Presets are a way to filter data and prepare visualizations.","name":"Presets"},{"description":"Preset Based Reports","name":"Reports"},{"description":"Routes to access the configuration of the risk scores.","name":"RiskScores"},{"description":"Routes to browse sensor folders.","name":"SensorExplorer"},{"description":"Routes to retrieve information about the enrolled sensors.","name":"Sensors"},{"description":"Routes to retrieve information about the sensor templates.","name":"SensorTemplates"},{"description":"Tags are meaningful labels applied to components and activities to describe network behaviors and device properties.","name":"Tags"},{"description":"Vulnerabilities are known security threats that could allow an attacker to gain unauthorized privileges.","name":"Vulnerabilities"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/api/3.0/","schemes":["https"],"securityDefinitions":{"token":{"description":"API token created in the Cyber Vision administration UI","type":"apiKey","name":"x-token-id","in":"header"}}},"spec":{"description":"Get the activity count per protocol. Metrics only if we are connected on local center or standalone. Metrics and top centers if we are connected on global center filter by enrolled local center in params Warning: this endpoint is cached. This means that the returned data is not necessarily the latest. The cache is automatically updated, but can also be updated at will thanks to POST /dashboard/{widget_id}/refresh. More over, we can notify we are using this data with POST /dashboard/ping, and then increase its refresh priority.\n","tags":["Dashboard"],"summary":"Get the activity count per protocol.","operationId":"getProtocolDistributionMetricsAndTop","parameters":[{"type":"string","description":"enrolled local center id for which we want the metrics","name":"centerId","in":"query"},{"type":"string","description":"number of centers sent in payload","name":"limit","in":"query"}],"responses":{"200":{"description":"object successful","schema":{"description":"JSON representation for counters","type":"object","properties":{"centers":{"type":"array","items":{"type":"object","properties":{"centerId":{"type":"string","x-go-name":"CenterId"},"centerName":{"type":"string","x-go-name":"CenterName"},"total":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","format":"int64","x-go-name":"Count"},"tagId":{"type":"string","x-go-name":"TagId"},"tagLabel":{"type":"string","x-go-name":"TagLabel"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/TotalDistributionProtocol"},"x-go-name":"Total"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/CenterDistributionProtocol"},"x-go-name":"Centers"},"total":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","format":"int64","x-go-name":"Count"},"tagId":{"type":"string","x-go-name":"TagId"},"tagLabel":{"type":"string","x-go-name":"TagLabel"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/TotalDistributionProtocol"},"x-go-name":"Total"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/WidgetProtocolDistributionResponse"}},"400":{"description":"bad request (for instance not uuid in centerId param)"},"401":{"description":"incorrect token"},"default":{"description":"unexpected error"}},"__originalOperationId":"getProtocolDistributionMetricsAndTop","consumes":["application/json"],"produces":["application/json"],"security":[{"token":[]}],"method":"get","path":"/dashboard/protocols/counts"}}