Filter endpoint agents

POST {{baseUrl}}/endpoint/agents/filter?max=5&cursor=&aid=1234&expand=clients,vpnProfiles,networkInterfaceProfiles&includeDeleted=false

Retrieves a list of endpoint agents within the specified account group that match the specified filters.

If no agents meet the filter criteria, the API returns an empty array.

Request Params

Key	Datatype	Description
`max`	number	(Optional) Maximum number of objects to return.
`cursor`	null	(Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.
`aid`	number	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
`expand`	string	This optional parameter allows you to control the expansion of test resources associated with the agent. By default, no expansion occurs when this query parameter is omitted.
To expand the "clients" resource, include the query parameter `?expand=clients`.

For multiple expansions, you have two options:

Separate the values with commas. For example, ?expandAgent=clients,tasks.
Specify the parameter multiple times. For example, ?expandAgent=clients&expandAgent=tasks.

This parameter offers flexibility for users to customize the expansion of specific resources related to the agent. | | includeDeleted | boolean | | When requesting entities, set to true if you want to see deleted entities. |

Request Body

{"searchFilters"=>{"agentName"=>["myagent-1234", "myagent-1234"], "computerName"=>["DESKTOP-45AE8", "DESKTOP-45AE8"], "username"=>["picard"], "platform"=>["mac", "mac"], "osVersion"=>["Version 10.15.2", "Version 10.15.2"], "locationCountryISO"=>["FR", "FR"], "locationSubdivision1Code"=>["ENG", "ENG"], "locationCity"=>["Paris", "Paris"], "licenseType"=>["essentials", "essentials"]}, "thresholdFilter"=>{"filters"=>[{"name"=>"last-seen-ms", "value"=>28326477.89569065, "operator"=>"gte"}, {"name"=>"last-seen-ms", "value"=>69398083.60802838, "operator"=>"gte"}], "conditionalOperator"=>"and"}, "searchSort"=>[{"sort"=>"platform", "order"=>"desc"}, {"sort"=>"city", "order"=>"desc"}]}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string
`Accept`	string

RESPONSES

status: OK

{&quot;totalAgents&quot;:1,&quot;agents&quot;:[{&quot;id&quot;:&quot;861b7557-cd57-4bbb-b648-00bddf88ef49&quot;,&quot;aid&quot;:&quot;1234&quot;,&quot;name&quot;:&quot;Office Printer&quot;,&quot;computerName&quot;:&quot;DESKJET-123&quot;,&quot;osVersion&quot;:&quot;Version 10.15.2 (Build 19C57)&quot;,&quot;platform&quot;:&quot;mac&quot;,&quot;kernelVersion&quot;:&quot;Darwin 19.2.0&quot;,&quot;manufacturer&quot;:&quot;Apple, Inc.&quot;,&quot;model&quot;:&quot;MacBookAir7,2&quot;,&quot;lastSeen&quot;:&quot;2022-05-26T23:37:16Z&quot;,&quot;status&quot;:&quot;enabled&quot;,&quot;deleted&quot;:false,&quot;version&quot;:&quot;0.123.4&quot;,&quot;createdAt&quot;:&quot;2022-05-26T23:37:16Z&quot;,&quot;numberOfClients&quot;:3,&quot;publicIP&quot;:&quot;88.45.2.123&quot;,&quot;location&quot;:{&quot;latitude&quot;:51.51279,&quot;longitude&quot;:-0.09184,&quot;locationName&quot;:&quot;London&quot;},&quot;clients&quot;:[{&quot;userProfile&quot;:{&quot;userName&quot;:&quot;joeblogs32&quot;},&quot;browserExtensions&quot;:[{&quot;browser&quot;:&quot;edge&quot;,&quot;profile&quot;:&quot;Profile 1&quot;,&quot;version&quot;:&quot;0.123.0&quot;,&quot;enabled&quot;:true,&quot;active&quot;:false,&quot;error&quot;:&quot;&quot;},{&quot;browser&quot;:&quot;edge&quot;,&quot;profile&quot;:&quot;Profile 1&quot;,&quot;version&quot;:&quot;0.123.0&quot;,&quot;enabled&quot;:true,&quot;active&quot;:false,&quot;error&quot;:&quot;&quot;}]},{&quot;userProfile&quot;:{&quot;userName&quot;:&quot;joeblogs32&quot;},&quot;browserExtensions&quot;:[{&quot;browser&quot;:&quot;edge&quot;,&quot;profile&quot;:&quot;Profile 1&quot;,&quot;version&quot;:&quot;0.123.0&quot;,&quot;enabled&quot;:true,&quot;active&quot;:false,&quot;error&quot;:&quot;&quot;},{&quot;browser&quot;:&quot;edge&quot;,&quot;profile&quot;:&quot;Profile 1&quot;,&quot;version&quot;:&quot;0.123.0&quot;,&quot;enabled&quot;:true,&quot;active&quot;:false,&quot;error&quot;:&quot;&quot;}]}],&quot;totalMemory&quot;:&quot;16384 MB&quot;,&quot;agentType&quot;:&quot;endpoint&quot;,&quot;vpnProfiles&quot;:[{&quot;vpnClientAddresses&quot;:[&quot;10.100.0.10&quot;],&quot;vpnClientNetworkRange&quot;:[&quot;10.100.0.0/22&quot;],&quot;interfaceName&quot;:&quot;minim officia labore nisi&quot;,&quot;vpnType&quot;:&quot;cisco-anyconnect&quot;,&quot;vpnGatewayAddress&quot;:&quot;culpa l&quot;},{&quot;vpnClientAddresses&quot;:[&quot;10.100.0.10&quot;],&quot;vpnClientNetworkRange&quot;:[&quot;10.100.0.0/22&quot;],&quot;interfaceName&quot;:&quot;sint aliqua irure id&quot;,&quot;vpnType&quot;:&quot;cisco-anyconnect&quot;,&quot;vpnGatewayAddress&quot;:&quot;anim dolor fugiat&quot;}],&quot;networkInterfaceProfiles&quot;:[{&quot;interfaceName&quot;:&quot;en0&quot;,&quot;addressProfiles&quot;:[{&quot;addressType&quot;:&quot;unique-local&quot;,&quot;ipAddress&quot;:&quot;2001:db8:3333:4444:5555:6666:7777:8888&quot;,&quot;prefixLength&quot;:24,&quot;gateway&quot;:&quot;192.168.0.254&quot;,&quot;routerHardwareAddress&quot;:&quot;5c:b1:3e:46:1c:84&quot;},{&quot;addressType&quot;:&quot;unique-local&quot;,&quot;ipAddress&quot;:&quot;2001:db8:3333:4444:5555:6666:7777:8888&quot;,&quot;prefixLength&quot;:24,&quot;gateway&quot;:&quot;192.168.0.254&quot;,&quot;routerHardwareAddress&quot;:&quot;5c:b1:3e:46:1c:84&quot;}],&quot;hardwareType&quot;:&quot;wireless&quot;,&quot;ethernetProfile&quot;:{&quot;linkSpeed&quot;:66638858},&quot;wirelessProfile&quot;:{&quot;bssid&quot;:&quot;00:11:22:aa:bb:cc&quot;,&quot;ssid&quot;:&quot;GuestWiFi&quot;,&quot;rssi&quot;:-36,&quot;channel&quot;:48,&quot;phyMode&quot;:&quot;802.11ac&quot;}},{&quot;interfaceName&quot;:&quot;en0&quot;,&quot;addressProfiles&quot;:[{&quot;addressType&quot;:&quot;unique-local&quot;,&quot;ipAddress&quot;:&quot;2001:db8:3333:4444:5555:6666:7777:8888&quot;,&quot;prefixLength&quot;:24,&quot;gateway&quot;:&quot;192.168.0.254&quot;,&quot;routerHardwareAddress&quot;:&quot;5c:b1:3e:46:1c:84&quot;},{&quot;addressType&quot;:&quot;unique-local&quot;,&quot;ipAddress&quot;:&quot;2001:db8:3333:4444:5555:6666:7777:8888&quot;,&quot;prefixLength&quot;:24,&quot;gateway&quot;:&quot;192.168.0.254&quot;,&quot;routerHardwareAddress&quot;:&quot;5c:b1:3e:46:1c:84&quot;}],&quot;hardwareType&quot;:&quot;wireless&quot;,&quot;ethernetProfile&quot;:{&quot;linkSpeed&quot;:3805390},&quot;wirelessProfile&quot;:{&quot;bssid&quot;:&quot;00:11:22:aa:bb:cc&quot;,&quot;ssid&quot;:&quot;GuestWiFi&quot;,&quot;rssi&quot;:-36,&quot;channel&quot;:48,&quot;phyMode&quot;:&quot;802.11ac&quot;}}],&quot;asnDetails&quot;:{&quot;asNumber&quot;:5089,&quot;asName&quot;:&quot;Virgin Media Limited&quot;},&quot;licenseType&quot;:&quot;essentials&quot;,&quot;tcpDriverAvailable&quot;:false,&quot;npcapVersion&quot;:&quot;amet occaecat&quot;,&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;https://api.thousandeyes.com/v7/link/to/resource/id&quot;,&quot;templated&quot;:false,&quot;type&quot;:&quot;ullamco non anim laborum&quot;,&quot;deprecation&quot;:&quot;et amet tempor&quot;,&quot;name&quot;:&quot;non&quot;,&quot;profile&quot;:&quot;ullamco ut est culpa&quot;,&quot;title&quot;:&quot;laboris veniam Excepteur irure&quot;,&quot;hreflang&quot;:&quot;reprehenderit consequat&quot;}}},{&quot;id&quot;:&quot;861b7557-cd57-4bbb-b648-00bddf88ef49&quot;,&quot;aid&quot;:&quot;1234&quot;,&quot;name&quot;:&quot;Office Printer&quot;,&quot;computerName&quot;:&quot;DESKJET-123&quot;,&quot;osVersion&quot;:&quot;Version 10.15.2 (Build 19C57)&quot;,&quot;platform&quot;:&quot;mac&quot;,&quot;kernelVersion&quot;:&quot;Darwin 19.2.0&quot;,&quot;manufacturer&quot;:&quot;Apple, Inc.&quot;,&quot;model&quot;:&quot;MacBookAir7,2&quot;,&quot;lastSeen&quot;:&quot;2022-05-26T23:37:16Z&quot;,&quot;status&quot;:&quot;enabled&quot;,&quot;deleted&quot;:false,&quot;version&quot;:&quot;0.123.4&quot;,&quot;createdAt&quot;:&quot;2022-05-26T23:37:16Z&quot;,&quot;numberOfClients&quot;:3,&quot;publicIP&quot;:&quot;88.45.2.123&quot;,&quot;location&quot;:{&quot;latitude&quot;:51.51279,&quot;longitude&quot;:-0.09184,&quot;locationName&quot;:&quot;London&quot;},&quot;clients&quot;:[{&quot;userProfile&quot;:{&quot;userName&quot;:&quot;joeblogs32&quot;},&quot;browserExtensions&quot;:[{&quot;browser&quot;:&quot;edge&quot;,&quot;profile&quot;:&quot;Profile 1&quot;,&quot;version&quot;:&quot;0.123.0&quot;,&quot;enabled&quot;:false,&quot;active&quot;:false,&quot;error&quot;:&quot;&quot;},{&quot;browser&quot;:&quot;edge&quot;,&quot;profile&quot;:&quot;Profile 1&quot;,&quot;version&quot;:&quot;0.123.0&quot;,&quot;enabled&quot;:false,&quot;active&quot;:true,&quot;error&quot;:&quot;&quot;}]},{&quot;userProfile&quot;:{&quot;userName&quot;:&quot;joeblogs32&quot;},&quot;browserExtensions&quot;:[{&quot;browser&quot;:&quot;edge&quot;,&quot;profile&quot;:&quot;Profile 1&quot;,&quot;version&quot;:&quot;0.123.0&quot;,&quot;enabled&quot;:false,&quot;active&quot;:false,&quot;error&quot;:&quot;&quot;},{&quot;browser&quot;:&quot;edge&quot;,&quot;profile&quot;:&quot;Profile 1&quot;,&quot;version&quot;:&quot;0.123.0&quot;,&quot;enabled&quot;:false,&quot;active&quot;:true,&quot;error&quot;:&quot;&quot;}]}],&quot;totalMemory&quot;:&quot;16384 MB&quot;,&quot;agentType&quot;:&quot;endpoint&quot;,&quot;vpnProfiles&quot;:[{&quot;vpnClientAddresses&quot;:[&quot;10.100.0.10&quot;],&quot;vpnClientNetworkRange&quot;:[&quot;10.100.0.0/22&quot;],&quot;interfaceName&quot;:&quot;aliqua eiusmod&quot;,&quot;vpnType&quot;:&quot;cisco-anyconnect&quot;,&quot;vpnGatewayAddress&quot;:&quot;tempor in dolor in&quot;},{&quot;vpnClientAddresses&quot;:[&quot;10.100.0.10&quot;],&quot;vpnClientNetworkRange&quot;:[&quot;10.100.0.0/22&quot;],&quot;interfaceName&quot;:&quot;ut&quot;,&quot;vpnType&quot;:&quot;cisco-anyconnect&quot;,&quot;vpnGatewayAddress&quot;:&quot;dolor enim nulla&quot;}],&quot;networkInterfaceProfiles&quot;:[{&quot;interfaceName&quot;:&quot;en0&quot;,&quot;addressProfiles&quot;:[{&quot;addressType&quot;:&quot;unique-local&quot;,&quot;ipAddress&quot;:&quot;2001:db8:3333:4444:5555:6666:7777:8888&quot;,&quot;prefixLength&quot;:24,&quot;gateway&quot;:&quot;192.168.0.254&quot;,&quot;routerHardwareAddress&quot;:&quot;5c:b1:3e:46:1c:84&quot;},{&quot;addressType&quot;:&quot;unique-local&quot;,&quot;ipAddress&quot;:&quot;2001:db8:3333:4444:5555:6666:7777:8888&quot;,&quot;prefixLength&quot;:24,&quot;gateway&quot;:&quot;192.168.0.254&quot;,&quot;routerHardwareAddress&quot;:&quot;5c:b1:3e:46:1c:84&quot;}],&quot;hardwareType&quot;:&quot;wireless&quot;,&quot;ethernetProfile&quot;:{&quot;linkSpeed&quot;:87130464},&quot;wirelessProfile&quot;:{&quot;bssid&quot;:&quot;00:11:22:aa:bb:cc&quot;,&quot;ssid&quot;:&quot;GuestWiFi&quot;,&quot;rssi&quot;:-36,&quot;channel&quot;:48,&quot;phyMode&quot;:&quot;802.11ac&quot;}},{&quot;interfaceName&quot;:&quot;en0&quot;,&quot;addressProfiles&quot;:[{&quot;addressType&quot;:&quot;unique-local&quot;,&quot;ipAddress&quot;:&quot;2001:db8:3333:4444:5555:6666:7777:8888&quot;,&quot;prefixLength&quot;:24,&quot;gateway&quot;:&quot;192.168.0.254&quot;,&quot;routerHardwareAddress&quot;:&quot;5c:b1:3e:46:1c:84&quot;},{&quot;addressType&quot;:&quot;unique-local&quot;,&quot;ipAddress&quot;:&quot;2001:db8:3333:4444:5555:6666:7777:8888&quot;,&quot;prefixLength&quot;:24,&quot;gateway&quot;:&quot;192.168.0.254&quot;,&quot;routerHardwareAddress&quot;:&quot;5c:b1:3e:46:1c:84&quot;}],&quot;hardwareType&quot;:&quot;wireless&quot;,&quot;ethernetProfile&quot;:{&quot;linkSpeed&quot;:16763529},&quot;wirelessProfile&quot;:{&quot;bssid&quot;:&quot;00:11:22:aa:bb:cc&quot;,&quot;ssid&quot;:&quot;GuestWiFi&quot;,&quot;rssi&quot;:-36,&quot;channel&quot;:48,&quot;phyMode&quot;:&quot;802.11ac&quot;}}],&quot;asnDetails&quot;:{&quot;asNumber&quot;:5089,&quot;asName&quot;:&quot;Virgin Media Limited&quot;},&quot;licenseType&quot;:&quot;essentials&quot;,&quot;tcpDriverAvailable&quot;:false,&quot;npcapVersion&quot;:&quot;dolor Lorem nostrud reprehenderit&quot;,&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;https://api.thousandeyes.com/v7/link/to/resource/id&quot;,&quot;templated&quot;:false,&quot;type&quot;:&quot;nulla &quot;,&quot;deprecation&quot;:&quot;magna do nulla quis&quot;,&quot;name&quot;:&quot;id ut non&quot;,&quot;profile&quot;:&quot;occaecat ullamco&quot;,&quot;title&quot;:&quot;ipsum eu&quot;,&quot;hreflang&quot;:&quot;in aute&quot;}}}],&quot;_links&quot;:{&quot;next&quot;:{&quot;href&quot;:&quot;https://api.thousandeyes.com/v7/link/to/resource/id&quot;,&quot;templated&quot;:true,&quot;type&quot;:&quot;qui elit cillum&quot;,&quot;deprecation&quot;:&quot;dolor&quot;,&quot;name&quot;:&quot;enim fugiat&quot;,&quot;profile&quot;:&quot;mollit et do nulla&quot;,&quot;title&quot;:&quot;pariatur nisi&quot;,&quot;hreflang&quot;:&quot;irure quis Duis ad dolore&quot;}}}