Documentation
¶
Overview ¶
Package analytics computes the dashboard's Overview: contacts, Engagement rates, automations and the daily time series (GLOSSARY "Engagement rates").
Engagement rates are a send cohort: the denominator is the Broadcast recipients sent in the window, and opens and clicks are counted among that same cohort, so opened never exceeds sent and every rate is within [0, 1]. They are not the Sending-domain Complaint and Bounce rates of internal/reputation.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Automations ¶
type Automations struct {
Total, Active, RunsActive, RunsCompleted int
}
Automations is a point-in-time snapshot.
type Contacts ¶
type Contacts struct {
Total, Active, Unsubscribed, NewInWindow int
}
Contacts: Unsubscribed is "globally non-mailable" (ADR 0001), Active the remainder.
type Module ¶
type Module struct {
// contains filtered or unexported fields
}
Module computes Overviews. Its clock is time.Now.
type Overview ¶
type Overview struct {
Contacts Contacts
Email Email
Automations Automations
Series []Point
}
Overview is everything the dashboard shows for one Workspace and window.
Source Files