Events API

User is able to view all Events via following endpoint:

curl --location 'https://{host}/api/enhancedEvents?startTs={start_timestamp}&limit={limit}&page={page_number}' \
--header 'x-Authorization: Bearer {token}' \
--data ''

Can be used following parameters:

• endTs: end timestamp
• entityIdUuid - Uuid of ENTITY
• entityName: DEVICE EUI/GATEWAY ID
• eventName:
  • GATEWAY_HIGH_TEMP_SHUTDOWN_ALARM
  • GATEWAY_LOW_BATTERY_ALARM
  • GATEWAY_SWITCHED_TO_BATTERY_POWER
  • GATEWAY_SWITCHED_TO_SECONDARY_NETWORK_INTERFACE_ALARM
  • GATEWAY_HIGH_RAM_UTILIZATION
  • GATEWAY_HIGH_DISK_UTILIZATION
  • GATEWAY_HIGH_CPU_UTILIZATION
  • SECURITY_ALARM
  • STATUS_UPDATE_ALARM
  • GATEWAY_SHUTDOWN_ALARM
  • GATEWAY_PERFORMANCE_DEGRADE_ALARM
  • GATEWAY_INTERFACE_ALARM
  • GATEWAY_AUTHENTICATION_ERROR
  • GATEWAY_EVENTS_REPORTING_RATE_EXCEEDED
  • GATEWAY_MQTT_RATE_EXCEEDED
  • DL_QUEUESIZE_EXCEEDED
  • DEVICE_CANNOT_JOIN
  • TOO_FREQUENT_UPLINKS
  • UNKNOWN_DEVICE
  • LORA_MIC_FAILURE
  • INTEGRATION_DL_ENCODING_FAILURE
  • GATEWAY_MQTT_CONNECTION_LOST
  • GATEWAY_DATA_REPORTING_INTERVAL_EXCEEDED
  • DEVICE_DATA_REPORTING_INTERVAL_EXCEEDED
  • INTEGRATION_DISCONNECTED
  • DECODER_
  • ENCODER_BANNED
• eventType:
  • Alarms
  • Faults
  • Events
  • Offline
• ituType:
• limit: 1-100(int)
• page: start from “0”(int)
• severity:
  • Critical
  • Major
  • Minor
• sortField
• sortOrder
• source:
  • GATEWAY
  • DEVICE
  • INTEGRATION
• startTs *: start timestamp
• state:
  • Raised
  • Clear

“*” - required field

A couple of examples of how to get a list of events with certain parameters are provided below:

• using Entity parameter:

https://{host}/api/enhancedEvents?startTs={start_timestamp}&limit={limit}&page={page}&source=GATEWAY

• using Entity Name parameter:

https://{host}/api/enhancedEvents?startTs={start_timestamp}&limit={limit}&page={page}&entityName=647FDAFFFE000000

• using Event Name parameter:

https://{host}/api/enhancedEvents?startTs={start_timestamp}&limit={limit}&page={page}&eventName=GATEWAY_HIGH_RAM_UTILISATION

User is able to view only events in the Raised state (without Cleared) via following endpoint:

curl --location 'https://{host}/api/enhancedEventsRaised?limit={limit}&page={page}&sortField=start_ts&sortOrder=desc&startTs=1689762193763' \
--header 'x-Authorization: Bearer {token}' \
--data ''

Can be used following parameters:

• endTs: end timestamp
• entityIdUuid - Uuid of ENTITY
• entityName: DEVICE EUI/GATEWAY ID
• eventName: *see Get All Enhanced Events section
• eventType:
  • Alarms
  • Faults
  • Events
  • Offline
• ituType:
• limit: 1-100(int)
• page: start from “0”(int)
• severity:
  • Critical
  • Major
  • Minor
• sortField
• sortOrder
• source:
  • GATEWAY
  • DEVICE
  • INTEGRATION
• startTs *: start timestamp

“*” - required field

User is able to get Entity’s Events via following endpoint:

curl --location 'https://{host}/api/entity/{entity_type}/{entity_ID}/enhancedEvents/{event_type}?limit={limit}&page={page}&startTs={start_timestamp}' \
--header 'x-Authorization: Bearer {token}' \
--data ''

Can be used following parameters:

• endTs: end timestamp
• entityId *: entity ID
  • entityType *:
  • GATEWAY
  • DEVICE
  • INTEGRATION
• eventType *:
  • Alarms
  • Faults
  • Events
  • Offline
• limit: 1-100(int)
• page: start from “0”(int)
• startTs *

“*” - required field