Group Search Results

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"
}
AllEntityType
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 Aggregation
aggregations
Optional

aggregations

array of string
group_by
Optional

group_by

array of AggregateOrderByClause
sort_by
Optional

sort_by

TimeRange
time_range
Optional

time_range

integer As int32 As int32
size
Optional

size

string
cursor
Optional

cursor

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns SearchGroupByResponse of type(s) application/json 
{
    "results": [
        {
            "bucket": [
                {
                    "field": "string",
                    "value": "string"
                }
            ],
            "count": 100,
            "aggregations": [
                {
                    "field": "string",
                    "aggregation_type": "string",
                    "value": "number"
                }
            ],
            "series_values": [
                {
                    "field": "string",
                    "aggregation_type": "string",
                    "resolution_in_secs": 0,
                    "series": [
                        [
                            {}
                        ]
                    ]
                }
            ]
        }
    ],
    "size": 0,
    "total_bucket": {
        "value": 0,
        "is_approx": false
    },
    "total_count": 1000,
    "time_range": {
        "start_time": 1597247025,
        "end_time": 1597247999
    },
    "cursor": "MTA="
}
array of GroupWithValue
results
Optional

results

integer As int32 As int32
size
Optional

size

Cardinality
total_bucket
Optional

total_bucket

integer As int32 As int32
total_count
Optional

Total count of objects returned

TimeRange
time_range
Optional

time_range

string
cursor
Optional

Cursor for the next page


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

array of ErrorDetail
details
Optional

details


401

Unauthorized

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure

On This Page
Search Operations
POST
Aggregate Search Results
POST
Group Search Results
POST
Search
POST
Search Entities