Docs.md

Classes

BetterstackAPIClient

BetterstackAPI is a class that interacts with the Betterstack API to manage monitors.

BetterstackMonitor

Monitor of a Betterstack system

BetterstackAPIClient

BetterstackAPI is a class that interacts with the Betterstack API to manage monitors.

Kind: global class

• BetterstackAPIClient
  • new BetterstackAPIClient(api_token)
  • .axios_instance : AxiosInstance
  • .getMonitors() ⇒ Promise.<(SuccessfulMonitorsReturn|UnsuccessfulResponse)>
  • .getMonitor(monitor_id) ⇒ Promise.<(SuccessfulMonitorReturn|UnsuccessfulResponse)>
  • .getMonitorResponseTimes(monitor_id, region) ⇒ Promise.<any>
  • .getLatestMonitorResponseTime(monitor_id, region) ⇒ Promise.<any>

new BetterstackAPIClient(api_token)

Creates an instance of BetterstackAPI.

Param	Type	Description
api_token	string	The API token for accessing the Betterstack API.

betterstackAPIClient.axios_instance : AxiosInstance

Get the axios instance

Kind: instance property of BetterstackAPIClient

betterstackAPIClient.getMonitors() ⇒ Promise.<(SuccessfulMonitorsReturn|UnsuccessfulResponse)>

Retrieves all monitors from the Betterstack API.

Kind: instance method of BetterstackAPIClient
Returns: Promise.<(SuccessfulMonitorsReturn|UnsuccessfulResponse)> - A promise that resolves to a successful or unsuccessful response.

betterstackAPIClient.getMonitor(monitor_id) ⇒ Promise.<(SuccessfulMonitorReturn|UnsuccessfulResponse)>

Retrieves a specific monitor by its ID from the Betterstack API.

Kind: instance method of BetterstackAPIClient
Returns: Promise.<(SuccessfulMonitorReturn|UnsuccessfulResponse)> - A promise that resolves to a successful or unsuccessful response.

Param	Type	Description
monitor_id	string	The ID of the monitor to retrieve.

betterstackAPIClient.getMonitorResponseTimes(monitor_id, region) ⇒ Promise.<any>

Gets the response times of a monitor from different or all regions

Kind: instance method of BetterstackAPIClient

Param	Type	Description
monitor_id	string	Id of the monitor
region	'eu' | 'us'	Defaults to sending all regions

betterstackAPIClient.getLatestMonitorResponseTime(monitor_id, region) ⇒ Promise.<any>

Gets the latest response time of a monitor from a region

Kind: instance method of BetterstackAPIClient

Param	Type	Default	Description
monitor_id	string | BetterstackMonitor		Id of the monitor
region	'eu' | 'us'	us	Defaults to "us"

BetterstackMonitor

Monitor of a Betterstack system

Kind: global class

• BetterstackMonitor
  • new BetterstackMonitor(monitor_id, api_client)
  • .api : BetterstackAPIClient
  • .id : string
  • .data : Monitor | undefined
  • .fetchData() ⇒ Promise.<(SuccessfulMonitorReturn|UnsuccessfulResponse)>

new BetterstackMonitor(monitor_id, api_client)

Set monitor id and the original api client

Param	Type
monitor_id	string
api_client	BetterstackAPIClient

betterstackMonitor.api : BetterstackAPIClient

Get the original Betterstack API Client

Kind: instance property of BetterstackMonitor

betterstackMonitor.id : string

Get the ID of the monitor

Kind: instance property of BetterstackMonitor

betterstackMonitor.data : Monitor | undefined

Get the cached data of the monitor

Kind: instance property of BetterstackMonitor

betterstackMonitor.fetchData() ⇒ Promise.<(SuccessfulMonitorReturn|UnsuccessfulResponse)>

Fetch the data from the monitor

Kind: instance method of BetterstackMonitor