/v2/extranet/service-overtime-consumption

Prev Next
Post
/v2/extranet/service-overtime-consumption

Get extranet service cumulative consumption over timewindow

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
id
integer (int64) Required

the id associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)

Example1
isB2B
boolean Required

whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)

Exampletrue
isProvider
boolean Required

whether the entity is a provider or consumer (required)

Exampletrue
siteId
integer (int64)

a filter to get usage for a specific site

Example1
subscriptionName
string

Optional subscription name for filter

Exampleexample string
timeWindow
object (statsmonTimeWindow) Required
bucketSizeSec
integer (int32) Required

the size of the time window in seconds (required)

Minimum0
Example300
oldTs
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
recentTs
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
vrfId
integer (int64)

a filter to get usage for a specific vrf

Example1
Responses
200

OK

Expand All
object
dlAggStats
Array of object (ipfixStats)
object
avgUsage
number (double)

Average service usage in kbps

Example1000000
peakUsage
number (double)

Peak service usage in kbps

Example1000000
ts
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
ulAggStats
Array of object (ipfixStats)
object
avgUsage
number (double)

Average service usage in kbps

Example1000000
peakUsage
number (double)

Peak service usage in kbps

Example1000000
ts
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011