Group Search Results
Using groupby search API you can group search results for vRealize Network Insight 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://vrni.example.com/api/ni/search/groupby
COPY
Request Body
GroupBy Request
SearchGroupByRequest of type(s) application/json
Optional
{
"entity_type": "Flow",
"filter": "destination_ip.ip_address = '1.1.1.1'",
"aggregations": [
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "SUM"
}
],
"time_range": {
"start_time": 1534410000,
"end_time": 1534410559
},
"group_by": [
"source_ip",
"destination_ip"
],
"size": 2,
"sort_by": [
{
"field": "flow.totalBytes.delta.summation.bytes",
"aggregation_type": "SUM",
"order": "DESC"
}
]
}string
filter
Optional
query filter
array of string
group_by
Optional
group_by
integer As int32 As int32
size
Optional
size
string
cursor
Optional
cursor
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="
}integer As int32 As int32
size
Optional
size
integer As int32 As int32
total_count
Optional
Total count of objects returned
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
401
Unauthorized
Operation doesn't return any data structure
500
Internal Error
Operation doesn't return any data structure