[{"label":"Latest (2022-09-01)","version":"latest"},{"version":"v1.0"}]
vmware-sase-platform

Get Enterprise Flow Metrics

Description

Fetch Customer-global network flow summary statistics

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/flowStats
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


Query Parameters

Query Parameters

integer
end Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.


string
groupBy Required

groupBy criteria according to which the result set is grouped. For example, a groupBy value of link produces an API response wherein each element corresponds to a distinct link record for which aggregate values are reported.


string
include Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.


string
metrics Optional

metrics supported for querying flowStats


string
sortBy Optional

sortBy query param to sort the resultset. Format of sortBy is <ASC | DESC>


integer
start Required

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.


Response

Response

Response Body

Response Body

200 OK

Returns array of InlineFlowStatsArray of type application/json

Request successfully processed

Errors

Errors

ValidationError
400

ValidationError


UnAuthorized
401

Unauthorized


ResourceNotFoundError
404

Resource not found


RateLimitExceededError
429

Rate Limit Exceeded


InternalServerError
500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/flowStats?groupBy=string&amp;start=10


Feedback

Was this page helpful?