Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.2.0

Jan 7, 2026

Changes in this version

+ var Version = "dev"

type Alert

+ Data map[string]interface{}

+ DeduplicationKey string

+ ExternalID string

+ GroupLeaderAlertID string

+ IsGroupLeaderAlert bool

+ Noise string

+ NotifiedUsers []AlertUser

+ RelatedIncidents []AlertIncident

+ URL string

+ type AlertIncident struct

+ ID string

+ SequentialID string

+ Status string

+ Title string

+ type AlertUser struct

+ Email string

+ Name string

type Incident

+ AsanaTaskURL string

+ CancelledAt *time.Time

+ ClosedAt *time.Time

+ ConfluencePageURL string

+ DatadogNotebookURL string

+ FreshserviceTicketURL string

+ GithubIssueURL string

+ GitlabIssueURL string

+ GoogleMeetingURL string

+ InTriageAt *time.Time

+ Labels map[string]string

+ LinearIssueURL string

+ MitigatedByEmail string

+ MitigatedByName string

+ MitigationMessage string

+ OpsgenieIncidentURL string

+ PagerdutyIncidentURL string

+ Private bool

+ ResolutionMessage string

+ ResolvedByEmail string

+ ResolvedByName string

+ RetrospectiveProgressStatus string

+ ScheduledFor *time.Time

+ ScheduledUntil *time.Time

+ ServiceNowIncidentURL string

+ SlackChannelArchived bool

+ SlackChannelName string

+ Source string

+ StartedByEmail string

+ StartedByName string

+ TrelloCardURL string

+ ZoomMeetingJoinURL string

+ func (i *Incident) Duration() int64

+ func (i *Incident) InTriageDuration() int64

+ func (i *Incident) MaintenanceDuration() int64

+ func (i *Incident) TimeToAcknowledge() float64

+ func (i *Incident) TimeToClose() float64

+ func (i *Incident) TimeToDetection() float64

+ func (i *Incident) TimeToMitigation() float64

+ func (i *Incident) TimeToResolution() float64

+ func (i *Incident) TimeToTriage() float64

type PaginationInfo

+ TotalCount int

+ TotalPages int

v0.1.0

Dec 31, 2025

Changes in this version

+ const CacheKeyPrefixAlertDetail

+ const CacheKeyPrefixAlerts

+ const CacheKeyPrefixIncidentDetail

+ const CacheKeyPrefixIncidents

+ const DefaultCacheTTL

+ type Alert struct

+ CreatedAt time.Time

+ Description string

+ DetailLoaded bool

+ EndedAt *time.Time

+ Environments []string

+ ExternalURL string

+ Groups []string

+ ID string

+ Labels map[string]string

+ Responders []string

+ Services []string

+ ShortID string

+ Source string

+ StartedAt *time.Time

+ Status string

+ Summary string

+ UpdatedAt time.Time

+ Urgency string

+ func MockAlerts() []Alert

+ type AlertsResult struct

+ Alerts []Alert

+ Pagination PaginationInfo

+ type Cache struct

+ func NewCache(ttl time.Duration) *Cache

+ func (c *Cache) Clear()

+ func (c *Cache) Delete(key string)

+ func (c *Cache) Get(key string) (interface{}, bool)

+ func (c *Cache) Set(key string, value interface{})

+ type CacheKeyBuilder struct

+ func NewCacheKey(prefix string) *CacheKeyBuilder

+ func (b *CacheKeyBuilder) Build() string

+ func (b *CacheKeyBuilder) With(key string, value interface{}) *CacheKeyBuilder

+ type Client struct

+ func NewClient(cfg *config.Config) (*Client, error)

+ func (c *Client) ClearCache()

+ func (c *Client) Close() error

+ func (c *Client) GetAlert(ctx context.Context, id string, updatedAt time.Time) (*Alert, error)

+ func (c *Client) GetIncident(ctx context.Context, id string, updatedAt time.Time) (*Incident, error)

+ func (c *Client) ListAlerts(ctx context.Context, page int) (*AlertsResult, error)

+ func (c *Client) ListIncidents(ctx context.Context, page int) (*IncidentsResult, error)

+ func (c *Client) ValidateAPIKey(ctx context.Context) error

+ type Incident struct

+ AcknowledgedAt *time.Time

+ Causes []string

+ CommanderName string

+ CommunicatorName string

+ CreatedAt time.Time

+ CreatedByEmail string

+ CreatedByName string

+ DetailLoaded bool

+ DetectedAt *time.Time

+ Environments []string

+ Functionalities []string

+ ID string

+ IncidentTypes []string

+ JiraIssueURL string

+ Kind string

+ MitigatedAt *time.Time

+ ResolvedAt *time.Time

+ Roles []IncidentRole

+ SequentialID string

+ Services []string

+ Severity string

+ ShortURL string

+ SlackChannelURL string

+ StartedAt *time.Time

+ Status string

+ Summary string

+ Teams []string

+ Title string

+ URL string

+ UpdatedAt time.Time

+ func MockIncidents() []Incident

+ type IncidentRole struct

+ Name string

+ UserEmail string

+ UserName string

+ type IncidentsResult struct

+ Incidents []Incident

+ Pagination PaginationInfo

+ type PaginationInfo struct

+ CurrentPage int

+ HasNext bool

+ HasPrev bool

+ type PersistentCache struct

+ func NewPersistentCache(ttl time.Duration) (*PersistentCache, error)

+ func (c *PersistentCache) Cleanup()

+ func (c *PersistentCache) Clear()

+ func (c *PersistentCache) Close() error

+ func (c *PersistentCache) Delete(key string)

+ func (c *PersistentCache) Get(key string) (interface{}, bool)

+ func (c *PersistentCache) GetTyped(key string, dest interface{}) bool

+ func (c *PersistentCache) Set(key string, value interface{})