HTTP
      Back to home
      1. AlphaX Help Center
      2. AlphaX API
      3. HTTP

      AlphaX Alert API Usage

      AlphaX Alert API provides a full set of alert/alarm information. Best used to register alarms and update alarms in other systems.

      HTTP Method

      GET Request

      Default URL

      https://api.alphax.cloud/conduitAlert?token=xxxxxxxxxxxxxxxxxxxx

      Important Note: When utilizing the default URL above, the API will fetch All alerts assigned to the entity associated with the token. For more information see the knowledge base for Working with Entities.

      Parameters

      Parameter Description Input Required
      token The unique security token for each user. This is available from the User window in AlphaX. String Required
      id The alert ID

      If not defined, you will get all alerts assigned to the entity associated with the token.      		 String Optional
      siteid

      The id of Entity (Heirarchy). You will get information of all alerts that assigned to the site and its sub sites.


      If not defined, you will get all alerts assigned to the entity associated with the token.

      		 String Optional

      Output

       

      Definition

      • Historical: Each record saved in database individually. Can not be manually changed in AlphaX platform.
      • Live: The data from current record. All of them were from one same record in database. Can be changed by editing fields in AlphaX platform.
      Output Key Description Data Type
      type   Type of the record Historical
      name Name of the Alert Live
      alertId ID of the Alert Historical
      siteid SiteID of the Alert

      Live
      siteName Site Name of the Alert Live
      conditionalStatus Active Condition of this Alert. See Detail below. Live
      alertStatus Active Condition of this Alert. See Detail below. Live
      conditions Alarm Conditions of this Alert. See Detail below.

      Live
      sensors Sensors associated with this Alert. See Detail below.

      Live

      Output Key: conditionalStatus & alertStatus

      • If conditionalStatus.status is auto , the alert will be actived/enabled during conditionalStatus.weekdays, conditionalStatus.months and conditionalStatus.timeRange. In the example above, the alert is active/enabled in January weekdays from 16:00 to 19:00.
      • If conditionalStatus.status is manual, the alert will be actived/enabled if the alertStatus is active.

      Output Key: conditions

      Output Key Description Data Type
      label Label of the Condition Live
      limit Limit/Value of this Condition Live
      condition Condition Live

      Values of condition

      Value Alert will be Triggered when:
      below The sensor value below limit
      equal The sensor value equal limit
      above The sensor value above limit
      offline The sensor is offline
      online The sensor is online
      error The sensor receives error code

      Output Key: sensors

      Output Key Description Data Type
      netid Network ID of this sensor Live
      chid Channel ID of this sensor Live
      lastTriggered Date of this Sensor last triggered within this Alert in number. 10 Digits Historical
      status Alarm status of this Sensor within this Alert
      If status = true: Sensor Alerted
      If status = false: Sensor NOT Alerted      		 Historical
      alertedConds Last triggered condition Historical

      Examples

      Get Information of All Alerts

      https://api.alphax.cloud/conduitAlert?token=xxxxxxxxxxxxxxxxxxxxxx

      Returns information of all alerts assigned to the entity associated with the token.

       

      Get Information of a specific Alert

      https://api.alphax.cloud/conduitAlert?token=xxxxxxxxxxxxxxxxxxxxxx&id=66xxxc14xxxb2

      Returns information of the Alert: 66xxxc14xxxb2