Retrieves the total count of clients by applying basic filtering - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Retrieves the total count of clients by applying basic filtering","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":"retrievesTheTotalCountOfClientsByApplyingBasicFiltering","tags":["Clients"],"summary":"Retrieves the total count of clients by applying basic filtering","deprecated":false,"description":"Retrieves the number of clients by applying basic filtering. 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-clients1-1.0.0-resolved.yaml","parameters":[{"name":"X-CALLER-ID","description":"Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It's an optional header parameter that can be added to an API request.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"startTime","description":"Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n\nIf `startTime` is not provided, API will default to current time.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"type","description":"The client device type whether client is connected to network through Wired or Wireless medium.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"osType","description":"Client device operating system type.\nThis field supports wildcard (`*`) character-based search. If the value contains the (`*`) character, please use the /query API for regex search. \nEx: `*iOS*` or `iOS*` or `*iOS`\nExamples:\n\n`osType=iOS` (single osType requested)\n\n`osType=iOS&osType=Android` (multiple osType requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"osVersion","description":"Client device operating system version\nThis field supports wildcard (`*`) character-based search. If the value contains the (`*`) character, please use the /query API for regex search. \nEx: `*14.3*` or `14.3*` or `*14.3`\nExamples:\n\n`osVersion=14.3` (single osVersion requested)\n\n`osVersion=14.3&osVersion=10.1` (multiple osVersion requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchy","description":"The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named \"Global\" (Ex. \"Global/AreaName/BuildingName/FloorName\") This field supports wildcard (`*`) character-based search. If the value contains the (`*`) character, please use the /query API for regex search. Ex: `*BuildingName*` or `BuildingName*` or `*BuildingName`\nExamples:\n`siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested)\n`siteHierarchy=Global/AreaName/BuildingName1/FloorName1&siteHierarchy=Global/AreaName/BuildingName1/FloorName2` (multiple siteHierarchy requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchyId","description":"The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. \"globalUuid/areaUuid/buildingUuid/floorUuid\") This field supports wildcard (`*`) character-based search. Ex: `*buildingUuid*` or `buildingUuid*` or `*buildingUuid`\nExamples:\n`siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid` (single siteHierarchyId requested)\n`siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid1&siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid2` (multiple siteHierarchyId requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteId","description":"The site UUID without the top level hierarchy. (Ex.\"floorUuid\") Examples:\n`siteId=floorUuid` (single siteId requested)\n`siteId=floorUuid1&siteId=floorUuid2` (multiple siteId requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"ipv4Address","description":"IPv4 Address of the network entity either network device or client\nThis field supports wildcard (`*`) character-based search. \nEx: `*1.1*` or `1.1*` or `*1.1`\n\nExamples:\n\n`ipv4Address=1.1.1.1` (single ipv4Address requested)\n\n`ipv4Address=1.1.1.1&ipv4Address=2.2.2.2` (multiple ipv4Address requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"ipv6Address","description":"IPv6 Address of the network entity either network device or client\nThis field supports wildcard (`*`) character-based search.\nEx: `*2001:db8*` or `2001:db8*` or `*2001:db8`\n\nExamples:\n\n`ipv6Address=2001:db8:0:0:0:0:2:1` (single ipv6Address requested)\n\n`ipv6Address=2001:db8:0:0:0:0:2:1&ipv6Address=2001:db8:85a3:8d3:1319:8a2e:370:7348` (multiple ipv6Address requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"macAddress","description":"The macAddress of the network device or client\nThis field supports wildcard (`*`) character-based search. \nEx: `*AB:AB:AB*` or `AB:AB:AB*` or `*AB:AB:AB`\nExamples:\n\n`macAddress=AB:AB:AB:CD:CD:CD` (single macAddress requested)\n\n`macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE` (multiple macAddress requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"wlcName","description":"Wireless Controller name that reports the wireless client.\nThis field supports wildcard (`*`) character-based search. If the value contains the (`*`) character, please use the /query API for regex search.\nEx: `*wlc-25*` or `wlc-25*` or `*wlc-25`\n\nExamples:\n\n`wlcName=wlc-25` (single wlcName requested)\n\n`wlcName=wlc-25&wlc-34` (multiple wlcName requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"connectedNetworkDeviceName","description":"Name of the neighbor network device that client is connected to.\nThis field supports wildcard (`*`) character-based search. If the value contains the (`*`) character, please use the /query API for regex search.\nEx: `*ap-25*` or `ap-25*` or `*ap-25`\n\nExamples:\n\n`connectedNetworkDeviceName=ap-25` (single connectedNetworkDeviceName requested)\n\n`connectedNetworkDeviceName=ap-25&ap-34` (multiple connectedNetworkDeviceName requested) \n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"ssid","description":"SSID is the name of wireless network to which client connects to. It is also referred to as WLAN ID - Wireless Local Area Network Identifier.\nThis field supports wildcard (`*`) character-based search. If the value contains the (`*`) character, please use the /query API for regex search. \nEx: `*Alpha*` or `Alpha*` or `*Alpha`\n\nExamples:\n\n`ssid=Alpha` (single ssid requested)\n\n`ssid=Alpha&ssid=Guest` (multiple ssid requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"band","description":"WiFi frequency band that client or Access Point operates. Band value is represented in Giga Hertz - GHz\nExamples:\n\n`band=5GHZ` (single band requested)\n\n`band=2.4GHZ&band=6GHZ` (multiple band requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Reponse object containing total count of the records after applying requested filters","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"count":{"type":"integer","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/RetrievesTheTotalCountOfClientsByApplyingBasicFilteringResponse"}}}},"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":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}},"default":{"description":"Unexpected Error","content":{}}},"x-rapi-id":"a486-4bef-4cab-9548","x-rapi-overview":"Retrieves the number of clients by applying basic filtering. 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-clients1-1.0.0-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Clients","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/clients/count","x-rapi-publicPath":"/dna/data/api/v1/clients/count","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"retrievesTheTotalCountOfClientsByApplyingBasicFiltering","method":"get","path":"/dna/data/api/v1/clients/count"}}