NodePing Elixir v1.7.1

NodePing.Notifications (NodePing Elixir v1.7.1) View Source

Get notifications for your checks

Link to this section Summary

Functions

get(token, opts, customerid \\ nil)

Get check notifications

get!(token, opts, customerid \\ nil)

Get check notifications

Link to this section Functions

Link to this function

get(token, opts, customerid \\ nil)

View Source

Get check notifications

Parameters

  • token - NodePing API token that is provided with account
  • opts - Map of optional arguments for getting a subset of notifications. nil if no opts

Opts

  • id - Check id of the check for which you want to list notifications
  • span - optional integer - number of hours of notifications to retrieve
  • limit - optional integer - number of records to retrieve. Defaults to 300
  • subaccounts - optional boolean - if set, notifications sent to subaccounts will also be included.

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> opts = %{:id => "201911191441YC6SJ-4S9OJ78G", :limit => 30}
iex> {:ok, result} = NodePing.Notifications.get(token, opts)
Link to this function

get!(token, opts, customerid \\ nil)

View Source

Get check notifications

Parameters

  • token - NodePing API token that is provided with account
  • opts - Map of optional arguments for getting a subset of notifications. nil if no opts

Opts

  • id - Check id of the check for which you want to list notifications
  • span - optional integer - number of hours of notifications to retrieve
  • limit - optional integer - number of records to retrieve. Defaults to 300
  • subaccounts - optional boolean - if set, notifications sent to subaccounts will also be included.

Examples 

iex> token = System.fetch_env!("TOKEN")
iex> opts = %{:id => "201911191441YC6SJ-4S9OJ78G", :limit => 30}
iex> result = NodePing.Notifications.get!(token, opts)