Group Search Results
Using groupby search API you can group search results for Operations for Networks entities by specifying entity type, filter expression, aggregate clause and groupby clause. Please refer to API Guide on details of how to construct filter expression, aggregate clause and groupby clause. A successful search request will return a list of groups.
Request
URI
POST
https://{api_host}/api/ni/search/groupby
COPY
Request Body
GroupBy Request
SearchGroupByRequest
of type(s)
application/json
Optional
{
"entity_type": "string",
"filter": "string",
"aggregations": [
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "string"
}
],
"group_by": [
"string"
],
"sort_by": [
{
"field": "string",
"aggregation_type": "string",
"order": "string"
}
],
"time_range": {
"start_time": 1597247025,
"end_time": 1597247999
},
"size": 0,
"cursor": "string"
}
string
entity_type
Optional
entity_type
Possible values are :
Group,
BaseSecurityGroup,
BaseEvent,
BaseVirtualMachine,
BaseFirewallRule,
BaseFirewallSection,
BaseIPSet,
BaseL2Network,
BaseFirewall,
BaseService,
BaseServiceGroup,
BaseVnic,
VirtualMachine,
EC2Instance,
Host,
Vnic,
Vmknic,
VxlanLayer2Network,
VlanL2Network,
Cluster,
SecurityTag,
ResourcePool,
NSXIPSet,
NSXTIPSet,
EC2IPSet,
NSXSecurityGroup,
NSGroup,
NSXPolicyGroup,
EC2SecurityGroup,
Flow,
ProblemEvent,
Application,
DiscoveredApplication,
Tier,
DiscoveredTier,
IPEndpoint,
NSXFirewallRule,
EC2SGFirewallRule,
NSXRedirectRule,
VCenterManager,
NSXVManager,
NSXTManager,
NSXPolicyManager,
CheckpointManager,
CheckpointMDSManager,
BaseManager,
BaseFirewallManager,
BaseNSXManager,
NSXService,
EC2Service,
NSService,
PolicyManagerServiceEntryConfig,
VPC,
CloudNetwork,
AzureVM,
AzureNSG,
AzureASG,
AzureNSGRule,
NSXDistributedFirewall,
EC2Firewall,
NSXServiceGroup,
NSServiceGroup,
PolicyManagerServiceConfig,
DistributedVirtualSwitch,
DistributedVirtualPortgroup,
VCDatacenter,
Datastore,
Folder,
NSXTFirewallRule,
NSXTFirewall,
PolicyManagerFirewallRule,
PolicyManagerFirewall,
BaseGenericFirewall,
BaseGenericFirewallRule,
CheckpointFirewall,
CheckpointFirewallRule,
UserDefinedSubnet,
KubernetesNamespace,
KubernetesService,
UserDefinedProblemEvent,
FirewallRuleMaskEvent,
EdgeDevice,
RouterDevice,
NSXController,
LogicalRouter,
NSXTManagementNode,
NSXTController,
NSXTTransportNode,
NSXTTransportZone,
NSXTLoadBalancer,
NSXTVirtualServer,
NSXTServerPool,
NSXTLogicalSwitch,
NSXTRouterDevice,
NSXTEdgeCluster,
NSXControllerCluster,
AzureSubscription,
AWSAccountManager,
HcxDataSource,
VMCSDDC,
VMCCapacityThresholdBreachEvent,
PolicyManagerSegment,
PolicyManagerFirewallSection,
DirectConnectInterface,
VMCSDDCGROUP,
AnalyticsThresholdCompositeProblemEvent,
VmcAWSDxConnection,
NsxPolicyBasedIPSecVPNSession,
NsxtPolicyBasedIPSecVPNSession,
VMWareTransitGateway,
SwitchPort,
RouterInterface,
HCXManager,
HCXSite,
HCXAppliance,
HCXNEAppliance,
HCXIXAppliance,
HCXWANOPTAppliance,
HCXTunnel,
HCXL2Extension,
HCXServiceMesh,
HCXService,
HCXNetworkProfile,
HCXComputeProfile,
KubernetesCluster,
KubernetesNode,
KubernetesPod,
VirtualDisk,
NSXTTransportNodeCPUCore,
string
filter
Optional
query filter
array of
object
aggregations
Optional
aggregations
array of
string
group_by
Optional
group_by
array of
object
sort_by
Optional
sort_by
object
time_range
Optional
time_range
integer As int32
As int32
size
Optional
size
string
cursor
Optional
cursor
Responses
200
Success
Returns
SearchGroupByResponse
of type(s)
application/json
"SearchGroupByResponse Object"
array of
object
results
Optional
results
integer As int32
As int32
size
Optional
size
object
total_bucket
Optional
total_bucket
integer As int32
As int32
total_count
Optional
Total count of objects returned
object
time_range
Optional
time_range
string
cursor
Optional
Cursor for the next page
400
Bad Request
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
401
Unauthorized
Operation doesn't return any data structure
500
Internal Error
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/search/groupby