WAN Interface Usage & Performance

Satellite terminal usage and performance metrics are accessed via the WAN interface Id. There are also convenience methods that allow the same data to be accessed via the installation Id.

VSAT RF Performance

This data is currently only available for VSAT terminals. To get recent RF performance of the VSAT terminal use the following method:

/api/waninterfaces/{wan-interface-id}/rfperformance?startTimeUnix={start-time}&endTimeUnix={end-time}&interval=300

The {start-time} and {end-time} parameters should be supplied in Unix Epoch timestamp seconds format. The interval is the summary duration for the returned data. Usually 300 seconds for short durations; 300 seconds (5 minutes) is the highest temporal resolution available in the data.

An example call for the VSAT terminal on "Example ship" (as shown above) is:

/api/waninterfaces/777/rfperformance?startTimeUnix=1630450800&endTimeUnix=1630537200&interval=300

This API method call will return the RF performance data for the VSAT terminal (WAN interface Id 777) between Sep 01 2021 at 00:00:00 and Sep 02 2021 at 00:00:00. The returned data is is the following format:

[{
    // lower-bound timestamp for this data value
    "unixEpochTimeStart": 1630450800,
  
    // upper-bound timestamp for this data value
    "unixEpochTimeEnd": 1630451100,  

    // Carrier-to-noise-density ratio (C/N0). Terminal's upstream average C/N0 as measured by the receiving line card. Expressed in dBHz.
    "upstreamCN0": 66.6662979,

    // Terminal's downstream average signal-to-noise ratio (SNR) as measured by the receiving terminal. Expressed in dB.
    "downstreamSnr": 9.0883541    
}, 
...]

An alternative is to query the RF performance for the installation by specifying the Installation Id. The following method returns data for the first VSAT terminal on the installation. This will return the same data as the call above:

/api/installations/{installation-id}/rfperformance?startTimeUnix={start-time}&endTimeUnix={end-time}&interval=300

An example call for the "Example ship" installation 329 (as shown above) is:

/api/installations/329/rfperformance?startTimeUnix=1630450800&endTimeUnix=1630537200&interval=300

VSAT Satellite Beam

This data is currently only available for VSAT terminals. To list the satellite beams used recently by the VSAT terminal use the following method:

/api/waninterfaces/{wan-interface-id}/beamusage?startTimeUnix={start-time}&endTimeUnix={end-time}&interval=300

The {start-time} and {end-time} parameters should be supplied in Unix Epoch timestamp seconds format. The interval is the summary duration for the returned data. Usually 300 seconds for short durations; 300 seconds (5 minutes) is the highest temporal resolution available in the data.

An example call for the VSAT terminal on "Example ship" (as shown above) is:

/api/waninterfaces/777/beamusage?startTimeUnix=1630450800&endTimeUnix=1630537200&interval=300

This API method call will return the satellite beam data for the VSAT terminal (WAN interface Id 777) between Sep 01 2021 at 00:00:00 and Sep 02 2021 at 00:00:00. The returned data is is the following format:

[
    {
        // lower-bound timestamp for this data value  
        "unixEpochTimeStart": 1630450800,    

        // upper-bound timestamp for this data value
        "unixEpochTimeEnd": 1630451100,

        // satellite beam name
        "beamName": "SES-14_NA09_WDB"   
    },
...]

Download Speeds

This data is currently only available for VSAT terminals. To retrieve download data transfer rate for a VSAT terminal use the following method:

/api/waninterfaces/{wan-interface-id}/downloadspeeds?startTimeUnix={start-time}&endTimeUnix={end-time}&interval=300

This data transfer rate is calculated based on the volume of data passed over the interval; it represents the average data transfer rate for the duration of the interval. Units for the data transfer rate are kilobits per second (Kbps).

The {start-time} and {end-time} parameters should be supplied in Unix Epoch timestamp seconds format. The interval is the summary duration for the returned data. Usually 300 seconds for short durations; 300 seconds (5 minutes) is the highest temporal resolution available in the data.

An example call for the VSAT terminal on "Example ship" (as shown above) is:

/api/waninterfaces/777/downloadspeeds?startTimeUnix=1630450800&endTimeUnix=1630537200&interval=300

This API method call will return the download data transfer rates for the VSAT terminal (WAN interface Id 777) between Sep 01 2021 at 00:00:00 and Sep 02 2021 at 00:00:00. The returned data is is the following format:

[    
      {
          // lower-bound timestamp for this data value
          "unixEpochTimeStart": 1630450800,

          // upper-bound timestamp for this data value
          "unixEpochTimeEnd": 1630451100,

          // data transfer rate in kilobits per second (Kbps)
          "dataRate": "64.58"
       },
...]

Upload Speeds

This data is currently only available for VSAT terminals. To retrieve upload data transfer rate for a VSAT terminal use the following method:

/api/waninterfaces/{wan-interface-id}/uploadspeeds?startTimeUnix={start-time}&endTimeUnix={end-time}&interval=300

This method is used in the same way as the downloads speeds method detailed above and returns data in the same format.

Data Volumes

This data is currently only available for VSAT terminals. To retrieve downloaded and uploaded data volumes for a VSAT terminal use the following method:

/api/waninterfaces/{wan-interface-id}/totaldatavolumes?startTimeUnix={start-time}&endTimeUnix={end-time}&interval=300

This data volume is the sum of data passed over each interval. Units for the data transfer volumes are megabytes (MB). The values returned represent total amount of IP data (entire IP packet, including headers) that has been received/transmitted over the air by the remote terminal. If TCP acceleration and if UDP compression is used, then this will reflect the size of the data after compression.

The {start-time} and {end-time} parameters should be supplied in Unix Epoch timestamp seconds format. The interval is the summary duration for the returned data. Usually 300 seconds for short durations; 300 seconds (5 minutes) is the highest temporal resolution available in the data.

An example call for the VSAT terminal on "Example ship" (as shown above) is:

/api/waninterfaces/777/totaldatavolumes?startTimeUnix=1630450800&endTimeUnix=1630537200&interval=300

This API method call will return the data volume totals for the VSAT terminal (WAN interface Id 777) between Sep 01 2021 at 00:00:00 and Sep 02 2021 at 00:00:00. The returned data is is the following format:

[
      {
          // lower-bound timestamp for this data value
          "unixEpochTimeStart": 1630450800,

          // upper-bound timestamp for this data value
          "unixEpochTimeEnd": 1630451100,

          // Data volume downloaded in the interval (MB).
          "downloadMb": "144.23"
          
          // Data volume uploaded in the interval (MB).
          "uploadMb": "26.96"
       },
...]

List the active WAN Interface for an Installation

The following method returns a listing showing which WAN interface was active on the installation over a specified time period:

GET /api/installations/{installation-id}/wanstatus

for example:

GET /api/installations/329/wanstatus

The data returned is in the following format:

[
    {
        // Aura Now installation Id
        "installationId": 329,
        // Time of the event in Unix Epoch time format
        "unixEpochTime": 1630870480,
        // WAN interface name in use (or "Offline")
        "interfaceName": "AuraVSAT",
        // WAN Connection status: online ("Up") or offline ("Down")?
        "status": "Up",
        // WAN interface Id
        "wanInterfaceId": 777,
        // WAN interface name
        "wanInterfaceName": "Example Terminal - VSAT",
        // WAN interface type Id
        "wanInterfaceTypeId": 1,
        // WAN interface type name
        "wanInterfaceTypeName": "VSAT"
    },
    {
        "installationId": 329,
        "unixEpochTime": 1630945204,
        "interfaceName": "Offline",
        "status": "Down"
    },
    {
        "installationId": 329,
        "unixEpochTime": 1630945562,
        "interfaceName": "IOP",
        "status": "Up"
    },
...]

The listing shows the "Example installation" (id 329) was using "AuraVSAT" at 1630870480 (2021-09-16 at 10:02:18 UTC), then went offline and came back up on the "IOP".

Note: please be aware that the wanInterfaceId, wanInterfaceName, wanInterfaceTypeId, and wanInterfaceTypeName properties may all be null if the terminal is offline, or online using a WAN interface that has not been configured in the Aura Now database. The interfaceName property is descriptive.