Qodex.ai

Show VPN history stat for networks in an organization

GET {{baseUrl}}/organizations/:organizationId/appliance/vpn/stats

Show VPN history stat for networks in an organization

Request Params

KeyDatatypeRequiredDescription
perPagestringThe number of entries per page returned. Acceptable range is 3 - 300. Default is 300.
startingAfterstringA token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
endingBeforestringA token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
networkIdsstringA list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456
t0stringThe beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1stringThe end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespanstringThe timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

HEADERS

KeyDatatypeRequiredDescription
X-Cisco-Meraki-API-Keynull

RESPONSES

status: OK

[{"networkId":"N_12345678","networkName":"San Francisco Office","merakiVpnPeers":[{"networkId":"L_23456789","networkName":"New York Office","usageSummary":{"receivedInKilobytes":1234567,"sentInKilobytes":2345678},"latencySummaries":[{"senderUplink":"wan1","receiverUplink":"wan1","avgLatencyMs":15,"minLatencyMs":10,"maxLatencyMs":30},{"senderUplink":"wan2","receiverUplink":"wan1","avgLatencyMs":15,"minLatencyMs":10,"maxLatencyMs":30}],"lossPercentageSummaries":[{"senderUplink":"wan1","receiverUplink":"wan1","avgLossPercentage":0,"minLossPercentage":0,"maxLossPercentage":0.1},{"senderUplink":"wan2","receiverUplink":"wan1","avgLossPercentage":0,"minLossPercentage":0,"maxLossPercentage":0.1}],"jitterSummaries":[{"senderUplink":"wan1","receiverUplink":"wan1","avgJitter":0.01,"minJitter":0,"maxJitter":0.25},{"senderUplink":"wan2","receiverUplink":"wan1","avgJitter":0.01,"minJitter":0,"maxJitter":0.25}],"mosSummaries":[{"senderUplink":"wan1","receiverUplink":"wan1","avgMos":4.1,"minMos":4,"maxMos":4.2},{"senderUplink":"wan2","receiverUplink":"wan1","avgMos":4.1,"minMos":4,"maxMos":4.2}]}]},{"networkId":"L_23456789","networkName":"New York Office","merakiVpnPeers":[{"networkId":"N_12345678","networkName":"San Francisco Office","usageSummary":{"receivedInKilobytes":2345678,"sentInKilobytes":1234567},"latencySummaries":[{"senderUplink":"wan1","receiverUplink":"wan1","avgLatencyMs":15,"minLatencyMs":10,"maxLatencyMs":30},{"senderUplink":"wan1","receiverUplink":"wan2","avgLatencyMs":15,"minLatencyMs":10,"maxLatencyMs":30}],"lossPercentageSummaries":[{"senderUplink":"wan1","receiverUplink":"wan1","avgLossPercentage":0,"minLossPercentage":0,"maxLossPercentage":0.1},{"senderUplink":"wan1","receiverUplink":"wan2","avgLossPercentage":0,"minLossPercentage":0,"maxLossPercentage":0.1}],"jitterSummaries":[{"senderUplink":"wan1","receiverUplink":"wan1","avgJitter":0.01,"minJitter":0,"maxJitter":0.25},{"senderUplink":"wan1","receiverUplink":"wan2","avgJitter":0.01,"minJitter":0,"maxJitter":0.25}],"mosSummaries":[{"senderUplink":"wan1","receiverUplink":"wan1","avgMos":4.1,"minMos":4,"maxMos":4.2},{"senderUplink":"wan1","receiverUplink":"wan2","avgMos":4.1,"minMos":4,"maxMos":4.2}]}]}]