request

type ComparePeriod struct {
	// From is the start date and time for the ComparePeriod.
	From time.Time

	// To is the end date and time for the ComparePeriod.
	To time.Time
}

type Direction string

type Filter struct {
	Operator  Operator
	Dimension dimensions.Dimension
	Values    []any
	Filter    []Filter
}

type FunnelRequest struct {
	// Ctx can be used to set a timeout or to cancel queries.
	Ctx context.Context

	// SiteID is the site ID for the request.
	SiteID uint64

	// Period is the period and timezone for the report.FunnelReport.
	Period Period

	// Filter filters the results for a report.FunnelReport per step.
	// Top-level filters are connected using the AND operator by default.
	// To use other operators, they need to be set in the Filter recursively.
	Filter [][]Filter

	// Options are optional fields for the FunnelRequest.
	Options *Options
}

type Operator int

type Options struct {
	// Sample sets the sampling size.
	Sample uint
}

type OrderBy struct {
	// Dimension to sort the results by. Either this field or Metric must be set.
	Dimension dimensions.Dimension

	// Metric to sor the results by. Either this field or Dimension must be set.
	Metric metrics.Metric

	// Direction to sort the results by (DirectionASC or DirectionDESC).
	Direction Direction
}

type Pagination struct {
	// Offset limits the number of results. Offset <= 0 means no offset.
	Offset int

	// Limit limits the number of results. Limit <= 0 means unlimited.
	Limit int
}

type Period struct {
	// From is the start date and time for the Period.
	From time.Time

	// To is the end date and time for the Period.
	To time.Time

	// Timezone is the timezone for the Request and Report.
	// It is set to UTC by default.
	Timezone *time.Location

	// WeekdayMode sets the start day of the week (WeekdayMonday or WeekdaySunday).
	// WeekdayMonday by default.
	WeekdayMode WeekdayMode

	// IncludeTime determines whether the From and To times should be included.
	IncludeTime bool

	// Compare is optional. When set, the query runs for both periods and results are merged.
	Compare *ComparePeriod
}

type Request struct {
	// Ctx can be used to set a timeout or to cancel queries.
	Ctx context.Context

	// SiteID is the site ID for the request.
	SiteID uint64

	// Period is the period and timezone for the report.Report.
	Period Period

	// Metrics is a list of result fields for the report.Report.
	Metrics []metrics.Metric

	// Dimensions is a list of attributes for the Request.
	Dimensions []dimensions.Dimension

	// Filter filters the results for a report.Report.
	// Top-level filters are connected using the AND operator by default.
	// To use other operators, they need to be set in the Filter recursively.
	Filter []Filter

	// OrderBy sorts the result fields of a report.Report.
	OrderBy []OrderBy

	// Pagination limits the number of results for a report.Report.
	Pagination *Pagination

	// Options are optional fields for the Request.
	Options *Options
}

type WeekdayMode int