Aggregate Search Results

Using aggregate API you can aggregate search results for vRealize Network Insight 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://vrni.example.com/api/ni/search/aggregation

COPY

Request Body

Aggregation Request

AggregationRequest 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
    }
}

AllEntityType

entity_type

Optional

entity_type

string

filter

Optional

query filter

array of Aggregation

aggregations

Optional

aggregations

TimeRange

time_range

Optional

time_range

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

Returns AggregationResponse of type(s) application/json

{
    "aggregations": [
        {
            "field": "string",
            "aggregation_type": "string",
            "value": "number"
        }
    ],
    "total_count": 100,
    "start_time": 1597247025,
    "end_time": 1597247999
}

array of AggregationWithValue

aggregations

Optional

aggregations

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

array of ErrorDetail

details

Optional

details