This is some documentation.




get_circuit_data

returns JSON formatted usage statistics for a circuit from start time to end time, and for a specific node or interface in the circuit.

circuit_id Required

The id of the circuit to fetch details for.

end Required

End time in epoch seconds.

interface

The name of the interface on the node to look at for the usage statistics. Must be specified when the node parameter is defined.

link

Name of the link to view data for, if specified node/interface should not be specified.

node

the node to look at for the circuit usage data.

start Required

Start time in epoch seconds.