api

Documentation

Index

• Constants
• type API
  • func NewClient(apiKey string) *API
  • func (api *API) GetApdex(token string) (*Apdex, error)
  • func (api *API) GetStatus(token string) (*Status, error)
  • func (api *API) SetUserAgent(app, version string)
• type Apdex
• type Status

Constants

const API_URL = "https://updown.io/api/checks"

API is API URL

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API is API client struct

func NewClient

func NewClient(apiKey string) *API

func (*API) GetApdex

func (api *API) GetApdex(token string) (*Apdex, error)

GetApdex fetches apdex info from updown API

func (*API) GetStatus

func (api *API) GetStatus(token string) (*Status, error)

GetStatus fetches status info from updown API

func (*API) SetUserAgent

func (api *API) SetUserAgent(app, version string)

SetUserAgent set user-agent string based on app name and version

type Apdex

type Apdex struct {
	Value float64 `json:"apdex"`
}

Apdex contains apdex (Application Performance Index) info

type Status

type Status struct {
	Uptime float64 `json:"uptime"`
	IsDown bool    `json:"down"`
}

Status contains info about check