Push API introduction

The Push API enables Eseye to stream live raw network data from various sources to a customer's web-based endpoint, for the purposes of monitoring and administering network usage.

You can subscribe to one or more of the following network data stream services:

  • NetFlow Raw Push – aggregates a wide variety of IP network traffic data per customer SIM, including:

    • Traffic source and destination IP addresses and port numbers
    • The number of bytes and IP packets observed in the traffic flow

    Network administrators can analyse the data to understand the traffic flow and volume across their SIM estate network, which may inform business decisions. For example, a business may need to purchase new hardware in areas of high usage to ease traffic flow congestion, or retire a thing that is never used.

  • RADIUS Authentication – controls a user's network resource access. Network administrators can use the data to track network and device usage, and analyse networking issues.

  • RADIUS Accounting – accurately measures a RADIUS network user's start and stop times and traffic usage. This information is used for billing purposes and general network monitoring..

You can only view network information for SIMs that are already linked to your SIAM account.

Eseye makes data available instantly and does not supply historic data. You must store any data you want to retain.

Before you begin

Eseye will onboard you when you subscribe to a streaming service. You will need:

  • A SIAM account, with all your SIM cards linked to this account.
  • Your SIAM account portfolioID. Contact Eseye Support for more information: support@eseye.com.
  • A static IP address to receive data from the Push API, which Eseye will whitelist.
  • A web-based endpoint (such as an HTTP receiver) to receive push notifications via HTTPs.

    During onboarding, you will receive an IP address that you must whitelist in order to receive the push notifications.