Skip to main content

Get Route Statistics

Retrieves statistics about a specific route.

Authorizations: Administrator, Operator, Observer

Requests

GET /api/gateway/[Device ID]/statistics?routeID=[Route ID] cookie: sessionID: [Session ID]

Parameters

Name

Type

Description

Device ID

string

Device ID retreived via the Get Device Info command.

Route ID

string

Route ID retrieved via the Get Device Configuration command.

Response

Response varies depending on which protocol is used.

Note

The Source ID and Destination ID can be used in subsequent API calls to obtain their specific statistics. See Get Source Statistics and Get Destination Statistics for more information.

{ "collectedAt": [Date/time in Unix time], "route": { "name": "[Route Name]", "elapsedRunningTime": "00:00:14", "id": "[Route ID]", "state": "running", "source": { <Source Statistics object> }, "destinations": [ { <Destination Statistics object> } ] } }

Parameters

Name

Type

Description

collectedAt

string

Timestamp when statistics were collected.

route

object

Refer to the table below for the route object model.

The route object has the following fields:

Name

Type

Description

id

string

Unique identifier for the route.

name

string

Name of the route.

elapsedRunningTime

number

Either an empty string (for idle routes), or a string in HH:MM:SS format (e.g. 00:03:46).

state

string

Whether the route is running, idle, or stopped.

source

object

See Source Statistics Object Model for the source statistics object model.

destinations

object list

See Destinations Statistics Object Model for the destination statistics object model.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.