spec

Documentation

Index

• Constants
• type CreateSite
• type Global
• type List
• type Metric
  • func ParsMetric(k string) Metric
  • func (m Metric) Label() string
  • func (m Metric) MarshalJSON() ([]byte, error)
  • func (m Metric) String() string
  • func (m *Metric) UnmarshalJSON(b []byte) error
• type Metrics
• type One
• type Property
  • func ParseProperty(k string) Property
  • func (p Property) MarshalJSON() ([]byte, error)
  • func (p Property) String() string
  • func (p *Property) UnmarshalJSON(b []byte) error
• type PropertyResult
• type QueryOptions
• type QueryPropertyOptions
  • func (q *QueryPropertyOptions) Defaults()
• type Select
• type Series
• type Site
• type SiteList
• type Site_
• type UpdateSite

Constants

const BaseKey = "__root__"

Types

type CreateSite

type CreateSite struct {
	Domain      string  `json:"domain"`
	Public      *bool   `json:"public,omitempty"`
	Description *string `json:"description,omitempty"`
}

type Global

type Global[T uint64 | Metrics] struct {
	Elapsed time.Duration `json:"elapsed"`
	Result  T             `json:"result"`
}

type List

type List[T any] struct {
	Elapsed time.Duration `json:"elapsed"`
	Items   []T           `json:"items"`
}

type Metric

type Metric uint8

const (
	Visitors Metric = iota
	Views
	Events
	Visits
	BounceRates
	VisitDurations
)

func ParsMetric

func ParsMetric(k string) Metric

func (Metric) Label

func (m Metric) Label() string

func (Metric) MarshalJSON

func (m Metric) MarshalJSON() ([]byte, error)

func (Metric) String

func (m Metric) String() string

func (*Metric) UnmarshalJSON

func (m *Metric) UnmarshalJSON(b []byte) error

type Metrics

type Metrics struct {
	Visitors uint64 `json:"visitors,omitempty"`
	Views    uint64 `json:"views,omitempty"`
	Events   uint64 `json:"events,omitempty"`
	Visits   uint64 `json:"visits,omitempty"`
}

type One

type One[T any] struct {
	Elapsed time.Duration `json:"elapsed"`
	Item    T             `json:"item"`
}

type Property

type Property uint8

const (
	Base Property = iota
	Event
	Page
	EntryPage
	ExitPage
	Referrer
	UtmMedium
	UtmSource
	UtmCampaign
	UtmContent
	UtmTerm
	UtmDevice
	UtmBrowser
	BrowserVersion
	Os
	OsVersion
	Country
	Region
	City
)

func ParseProperty

func ParseProperty(k string) Property

func (Property) MarshalJSON

func (p Property) MarshalJSON() ([]byte, error)

func (Property) String

func (p Property) String() string

func (*Property) UnmarshalJSON

func (p *Property) UnmarshalJSON(b []byte) error

type PropertyResult

type PropertyResult[T uint64 | []uint64] struct {
	Timestamps []int64       `json:"timestamps"`
	Elapsed    time.Duration `json:"elapsed"`
	Result     map[string]T  `json:"result"`
}

type QueryOptions

type QueryOptions struct {
	Window time.Duration `json:"window,omitempty"`
	Offset time.Duration `json:"offset,omitempty"`
	Metric Metric        `json:"metric,omitempty"`
}

type QueryPropertyOptions

type QueryPropertyOptions struct {
	Window   time.Duration `json:"window,omitempty"`
	Offset   time.Duration `json:"offset,omitempty"`
	Metric   Metric        `json:"metric,omitempty"`
	Property Property      `json:"property,omitempty"`
	Selector Select        `json:"selector,omitempty"`
}

func (*QueryPropertyOptions) Defaults

func (q *QueryPropertyOptions) Defaults()

type Select

type Select struct {
	Exact *string `json:"exact,omitempty"`
	Re    *string `json:"re,omitempty"`
	Glob  *string `json:"glob,omitempty"`
}

type Series

type Series[T uint64 | []uint64] struct {
	Timestamps []int64       `json:"timestamps,omitempty"`
	Elapsed    time.Duration `json:"elapsed"`
	Result     T             `json:"result"`
}

type Site

type Site One[Site_]

type SiteList

type SiteList List[Site_]

type Site_

type Site_ struct {
	Domain      string    `json:"domain"`
	Public      bool      `json:"public,omitempty"`
	Description string    `json:"desc,omitempty"`
	Owner       string    `json:"owner"`
	CreatedAt   time.Time `json:"createdAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
}

type UpdateSite

type UpdateSite struct {
	Public      *bool   `json:"public,omitempty"`
	Description *string `json:"description,omitempty"`
}