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

Get Enterprise Link Metrics

Description

Fetch aggregate WAN link transport metrics for all Customer links

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/linkStats
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
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 linkStats


string
sortBy Optional

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


integer
start Optional

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


Response

Response

Response Body

Response Body

200 OK

Returns array of InlinelinkStatsArray 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}/linkStats


Feedback

Was this page helpful?