Skip to main content
GET
/
alerts
Get alerts that match the given parameters
curl --request GET \
  --url https://dashboard.hologram.io/api/1/alerts \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 123,
  "size": 123,
  "continues": true,
  "data": [
    {
      "planid": 123,
      "plan_amount": 123,
      "data_threshold": 123,
      "id": 123,
      "orgid": 123,
      "type": "<string>",
      "deviceid": 123,
      "acked": 123,
      "acked_by": 123,
      "acked_at": "<string>",
      "whencreated": "<string>",
      "device_name": "<string>",
      "cur_billing_data_used": 123,
      "last_billing_data_used": 123,
      "linkid": 123,
      "sim": "<string>",
      "state": "<string>",
      "expires": "<string>",
      "latitude": 123,
      "longitude": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key.

You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

id
integer
orgid
integer
Example:

144

type
enum<string>
Available options:
TAC_CHANGE,
CUSTOM,
Devices_DATA_LIMIT,
Devices_USAGE
acked
boolean

Response

200 - application/json

Get all alerts

Schema for response to request about alerts

success
boolean
limit
integer
size
integer
continues
boolean
data
object[]

Fields added when merging in device data