Aggregate Search Results
Using aggregate API you can aggregate search results for Operations for Networks entities by specifying entity type, filter expression and aggregate clause. Please refer to API Guide on details of how to construct filter expression and aggregate clause. A successful search request will return a list of aggregations.
Request
URI
POST
https://{api_host}/api/ni/search/aggregation
COPY
Request Body
Aggregation Request
AggregationRequest of type(s) application/json
Optional
{
"entity_type": "string",
"filter": "string",
"aggregations": [
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "string"
}
],
"time_range": {
"start_time": 1597247025,
"end_time": 1597247999
}
}
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
Responses
200
Success
Returns AggregationResponse of type(s) application/json
{
"aggregations": [
{
"field": "string",
"aggregation_type": "string",
"value": "number"
}
],
"series_values": [
{
"field": "string",
"aggregation_type": "string",
"resolution_in_secs": 0,
"series": [
[
{}
]
]
}
],
"total_count": 100,
"start_time": 1597247025,
"end_time": 1597247999
}integer As int32 As int32
total_count
Optional
Total count of objects returned
integer As int64 As int64
start_time
Optional
Start timestamp of the window of the objects returned
integer As int64 As int64
end_time
Optional
End timestamp of the window of the objects returned
400
Bad Request
Returns ApiError of type(s) application/json
{
"code": 0,
"message": "string",
"details": [
{
"code": 0,
"message": "string",
"target": [
"string"
]
}
]
}integer As int32 As int32
code
Optional
code
string
message
Optional
message
401
Unauthorized
Operation doesn't return any data structure
500
Internal Error
Operation doesn't return any data structure