Telemetry Data

URL

            

            
GET /cyber-ai/telemetry/counters?type=<type>
        

Allowed Types:

• Link

• Cable

• Network

• Tenant

• Logical-server

Request Data

            

            
None
        

Response

            

            
{
"LinkDownedCounterExtended": "Link Downed Counter Extended",
"MaxRetransmissionRate": "Max Retransmission Rate",
"PortBufferOverrunErrors": "Port Buffer Overrun Errors",
"PortDLIDMappingErrors": "Port DLID Mapping Errors",
"PortFECCorrectableBlockCounter": "Port FEC Correctable Block Counter",
"PortFECCorrectedSymbolCounter": "Port FEC Corrected Symbol Counter",
"PortFECUncorrectableBlockCounter": "Port FEC Uncorrectable Block Counter",
...
}
        

URL

            

            
GET /cyber-ai/telemetry/network/traffic?period=<period_type>
        

Where period_type can be:

• weekly_average

• last_week

• current_week

Request Data

            

            
none
        

Response

            

            
[
  {
    "time": "06:00:00",
    "DOW": "Wed",
    "value": 50
  },
  {
    "time": "07:00:00",
    "DOW": "Wed",
    "value": 45
  }
 ]
        

URL for tenant

            

            
GET /cyber-ai/telemetry/tenant/{tenant_id}/{counter}
        

URL filters:

• From – retrieve alerts triggered within the last given time period:

  Copy

  Copied!

              
  
              
  ?from=-<time>
          

  Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: ?from=-6h.

• To – retrieve telemetry data for a given time point:

  Copy

  Copied!

              
  
              
  ?to=-<time>
          

Request Data

            

            
none
        

Response

            

            
[
  {
    "time": "06:00:00",
    "value": 45
  },
  {
    "time": "07:00:00",
    "value": 55
  }
 ]
        

Response codes

URL

            

            
GET /cyber-ai/telemetry/tenant/network/{counter}
        

URL filters:

• margin – retrieve telemetry data from a given time point:

  Copy

  Copied!

              
  
              
  ?margin=<time>
          

  Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: ? margin=1d.

• Time Per Tenant

  Copy

  Copied!

              
  
              
  ?time_per_tenant=<tenant_id>
          

Request Data

            

            
none
        

Response

            

            
[
  {
    "time": "06:00:00",
    "value": 45
  },
  {
    "time": "07:00:00",
    "value": 55
  }
 ]
        

Response codes

URL for tenant

            

            
GET /cyber-ai/telemetry/logical-server/<logical_server_id>/{counter}
        

URL filters

• From – retrieve telemetry data within the latest given time period

  Copy

  Copied!

              
  
              
  ?from=-<time>
          

  Warning

  Supported time units: h (for hours), d (for days), w (for weeks) and m (for months). For example: ?from=-6h.

• To – retrieve telemetry data for any given time point

  Copy

  Copied!

              
  
              
  ?to=-<time>
          

Request data

            

            
none
        

Response

            

            
[
  {
    "time": "2022-03-01 14:51:07.000000",
    "value": 1.1666666666666647e-254
  },
  {
    "time": "2022-03-01 15:51:07.000000",
    "value": 1.16668418566647e-182
  }
]
        

Response codes

URL

            

            
GET /cyber-ai/telemetry/link/{node_id}
        

URL filters:

• From – retrieve alerts triggered within the last given time period:

  Copy

  Copied!

              
  
              
  ?from=-<time>
          

  Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: ?from=-1d.

• Influencers

  Copy

  Copied!

              
  
              
  ?influencers=<comma-separated list of influencers>
          

• Average, return average data:

  Copy

  Copied!

              
  
              
  ?average=["True"|"False"]
          

Request Data

            

            
none
        

Response

            

            
[
  {
    "time": "06:00:00",
    "value": 45
  },
  {
    "time": "07:00:00",
    "value": 55
  }
 ]
        

URL

            

            
GET /cyber-ai/telemetry/cable/{cable_id}/{influencer}
        

URL filters:

• From – retrieve telemetry data within the last given time period:

  Copy

  Copied!

              
  
              
  ?from=-<time>
          

  Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: ?from=-6h.

• Probability – return all alerts with probability equal to, or greater than the given probability

  Copy

  Copied!

              
  
              
  ?min_probability=<0-100>
          

• Influencers:

  Copy

  Copied!

              
  
              
  ?influencers=<comma-separated list of influencers>
          

Request Data

            

            
none
        

Response

            

            
  {
    "time": "06:00:00",
    "value": 45
  },
  {
    "time": "07:00:00",
    "value": 55
  }
]