Documentation Index

Fetch the complete documentation index at: https://docs.graphiant.com/llms.txt

Use this file to discover all available pages before exploring further.

/v2/assurance/topology-overview

Prev Next
Post
/v2/assurance/topology-overview
Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Body parameters
Expand All
object
appName
string
Exampleexample string
appServerKey
string
Exampleexample string
bucketId
string
ExampleENUM_VALUE
exchangeServiceId
integer (int64)
Example1234567891011
filter
object (v2AssuranceTopologyOverviewPostRequestTopologyFilter)
clientSiteIds
Array of integer
integer (int64)
Example1234567891011
regionIds
Array of integer
integer (int32)
Example123
serverSiteIds
Array of integer
integer (int64)
Example1234567891011
flexAlgoId
integer (int64)
Example1234567891011
sliderTimeWindow
object (assuranceTimeWindow)
bucketSizeSec
integer (int32)
Minimum0
Example123
oldTs
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
recentTs
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
timeWindow
object (assuranceTimeWindow)
bucketSizeSec
integer (int32)
Minimum0
Example123
oldTs
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
recentTs
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
topologyTs
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
topologyType
string
ExampleENUM_VALUE
Responses
200

OK

Expand All
object
numApplications
integer (int32)
Example123
numFlows
integer (int32)
Example123
topology
object (assuranceTopology)
edges
Array of object (assuranceTopologyEdge)
object
destinationNodeId
string
Exampleexample string
performance
Array of object (assuranceTopologyEdgeLinkPerformance)
object
jitter
number (float)
Example12.34
latency
number (float)
Example12.34
loss
number (float)
Example12.34
sourceNodeId
string
Exampleexample string
nodes
Array of object (assuranceTopologyNode)
object
active
boolean
Exampletrue
location
object (assuranceGeolocation)
lat
number (float)
Example12.34
long
number (float)
Example12.34
name
string
Exampleexample string
nodeId
string
Exampleexample string
nodeType
string
ExampleENUM_VALUE
paths
Array of object (assuranceTopologyPath)
object
nodeIds
Array of string
string
Exampleexample string
topologyChangeTs
Array of object (googleProtobufTimestamp)
object
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
trafficRegions
Array of object (v2AssuranceTopologyOverviewPostResponseGeoregion)
object
numSites
integer (int32)
Example123
region
object (assuranceRegion)
regionId
integer (int32)
Example123
regionIsoCode
string
Exampleexample string
regionName
string
Exampleexample string