plausible

type AggregateQuery struct {
	// Period to consider for the aggregate query. The result will include results over this period of time.
	// This field is mandatory.
	Period TimePeriod
	// Metrics to be included in the aggregation result.
	// This field is mandatory.
	Metrics Metrics
	// Filters is a filter over properties to narrow down the aggregation results.
	// This field is optional.
	Filters Filter
	// ComparePreviousPeriod tells whether to include a comparison with the previous period in the query result.
	// This field is optional and will default to false.
	ComparePreviousPeriod bool
}

type AggregateResult struct {
	// BounceRate represents the bounce rate result for the query.
	// Only use this field if you included the BounceRate metric in your query.
	BounceRate float64 `json:"bounce_rate"`
	// BounceRateChange represents the bounce rate change compared to the previous period.
	// Only use this field if you included the BounceRate metric in your query and ComparePreviousPeriod was set to true.
	BounceRateChange float64 `json:"bounce_rate_change"`

	// Pageviews represents the page view result for the query.
	// Only use this field if you included the PageViews metric in your query.
	Pageviews int `json:"pageviews"`
	// PageviewsChange represents change in the number of pageviews compared to the previous period.
	// Only use this field if you included the PageViews metric in your query and ComparePreviousPeriod was set to true.
	PageviewsChange int `json:"pageviews_change"`

	// VisitDuration represents the visit duration result for the query.
	// Only use this field if you included the VisitDuration metric in your query
	VisitDuration float64 `json:"visit_duration"`
	// VisitDurationChange represents the visit duration change compared to the previous period.
	// Only use this field if you included the VisitVisitDuration metric in your query and ComparePreviousPeriod was set to true.
	VisitDurationChange float64 `json:"visit_duration_change"`

	// Visitors represents the number of visitors result for the query.
	// Only use this field if you included the Visitors metric in your query.
	Visitors int `json:"visitors"`
	// VisitorsChange represents the change in the number of visitors compared to the previous period.
	// Only use this field if you included the Visitors metric in your query and ComparePreviousPeriod was set to true.
	VisitorsChange int `json:"visitors_change"`

	// Visits represents the visits result for the query.
	// Only use this field if you included the Visits metric in your query
	Visits int `json:"visits"`
	// VisitsChange represents the visits change compared to the previous period.
	// Only use this field if you included the Visits metric in your query and ComparePreviousPeriod was set to true.
	VisitsChange int `json:"visits_change"`

	// Events represents the events result for the query.
	// Only use this field if you included the Events metric in your query
	Events int `json:"events"`
	// EventsChange represents the events change compared to the previous period.
	// Only use this field if you included the Events metric in your query and ComparePreviousPeriod was set to true.
	EventsChange int `json:"events_change"`
}

type BreakdownQuery struct {
	// Property is the property name for which the breakdown result will be about.
	// This field is mandatory.
	Property PropertyName
	// Period is the period of time to consider for the results.
	// This field is mandatory.
	Period TimePeriod
	// Metrics is a list of metrics for which to include in the results.
	// This field is optional.
	Metrics Metrics
	// Limit limits the number of results to be returned.
	// This field is optional.
	Limit int
	// Page indicates the page number for which to fetch the results. Page numbers start at 1.
	// This field is optional.
	Page int
	// Filters is a filter over properties to narrow down the breakdown results.
	// This field is optional.
	Filters Filter
}

type BreakdownResult []BreakdownResultEntry

type BreakdownResultEntry struct {
	// PropertyResult contains the property value associated with this entry
	PropertyResult
	// MetricsResult contains the metric information associated with this entry
	MetricsResult
}

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

type CreateSiteRequest struct {
	// Domain of the site to create.
	// This field is mandatory.
	Domain string
	// Timezone name according to the IANA database (e.g "Europe/London").
	// This field is optional and will default to "Etc/UTC".
	Timezone string
}

type CreateSiteResult struct {
	// Domain of the created site.
	Domain string `json:"domain"`
	// Timezone of the newly created site.
	Timezone string `json:"timezone"`
}

type Date struct {
	// Day of month of the date (1-31)
	Day int
	// Month of the date (1-12)
	Month int
	// Year of the date (1-12)
	Year int
}

type DateTime struct {
	Date
	Time
}

type Filter struct {
	// Properties to filter by
	Properties Properties
}

type Metric string

type Metrics []Metric

type MetricsResult struct {
	// BounceRateRaw contains information about the bounce rate.
	// This field must only be used if the query requested the bounce rate metric.
	// Even when the query requests information for the bounce rate metric, some data points can
	// have this field as nil.
	// If you don't care about the nil value, use the BounceRate function to get this value.
	BounceRateRaw *float64 `json:"bounce_rate"`

	// Pageviews contains information about the number of page views.
	// This field must only be used if the query requested the page views metric.
	Pageviews int `json:"pageviews"`

	// VisitDurationRaw contains information about the visit duration.
	// Only use this field if the query requested the visit duration metric.
	// Even when the query requests information for the visit duration metric, some data points can
	// have this field as nil.
	// If you don't care about the nil value, use the VisitDuration function to get this value.
	VisitDurationRaw *float64 `json:"visit_duration"`

	// Visitors contains information about the number of visitors.
	// This field must only be used if the query requested the visitors metric.
	Visitors int `json:"visitors"`

	// Visits contains information about the number of visits per session.
	// This field must only be used if the query requested the visits metric.
	Visits int `json:"visits"`
}

type Properties []Property

type Property struct {
	// Name is the name of the property
	Name PropertyName
	// Value is the value associated with the property
	Value string
}

type PropertyName string

type PropertyResult struct {
	// Name contains a value of the event name property.
	// This value must only be only if the breakdown query was for this property.
	Name string `json:"name"`
	// Page contains a value of the event page property.
	// This value must only be only if the breakdown query was for this property.
	Page string `json:"page"`
	// Page contains a value of the visit source property.
	// This value must only be only if the breakdown query was for this property.
	Source string `json:"source"`
	// Referrer contains a value of the visit referrer property.
	// This value must only be only if the breakdown query was for this property.
	Referrer string `json:"referrer"`
	// UtmMedium contains a value of the utm medium property.
	// This value must only be only if the breakdown query was for this property.
	UtmMedium string `json:"utm_medium"`
	// UtmSource contains a value of the utm source property.
	// This value must only be only if the breakdown query was for this property.
	UtmSource string `json:"utm_source"`
	// UtmCampaign contains a value of the utm campaign property.
	// This value must only be only if the breakdown query was for this property.
	UtmCampaign string `json:"utm_campaign"`
	// Device contains a value of the device property.
	// This value must only be only if the breakdown query was for this property.
	Device string `json:"device"`
	// Browser contains a value of the browser property.
	// This value must only be only if the breakdown query was for this property.
	Browser string `json:"browser"`
	// BrowserVersion contains a value of the browser version property.
	// This value must only be only if the breakdown query was for this property.
	BrowserVersion string `json:"browser_version"`
	// OS contains a value of the operating system property.
	// This value must only be only if the breakdown query was for this property.
	OS string `json:"os"`
	// OSVersion contains a value of the operating system version property.
	// This value must only be only if the breakdown query was for this property.
	OSVersion string `json:"os_version"`
	// Country contains a value of the country property.
	// This value must only be only if the breakdown query was for this property.
	Country string `json:"country"`
}

type QueryArg struct {
	// Name is the name of the query argument
	Name string
	// Value is the value for the query argument
	Value string
}

type QueryArgs []QueryArg

type SharedLinkRequest struct {
	// Name is the name of the shared link.
	// This field is required.
	Name string
}

type SharedLinkResult struct {
	// Name is the name of the shared link
	Name string `json:"name"`
	// URL is the URL for the shared link
	URL string `json:"url"`
}

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

type Time struct {
	// Hour of a given time of day
	Hour int
	// Minute of a given time of day
	Minute int
	// Second of a given time of day
	Second int
}

type TimeInterval string

type TimePeriod struct {
	// Period is a string representing a period of time, e.g "6mo", "12mo", "7d", "30d", "custom", "month", "day" or "custom".
	// This field is mandatory.
	Period string
	// Date is a string representing a date to which the time period refers to, in the format of "yyyy-mm-dd"
	// This field is optional.
	Date string
}

type TimeseriesDataPoint struct {
	// Date is a string containing information about the date this result refers to in the format of "yyyy-mm-dd".
	// For some queries, this string will also include information about an hour of day, in the format "yyyy-mm-dd hh:mm:ss"
	Date string `json:"date"`
	// MetricsResult contains the metric results for the metrics included in the query
	MetricsResult
}

type TimeseriesQuery struct {
	// Period to consider for the time series query.
	// The result will include results over this period of time.
	// This field is mandatory.
	Period TimePeriod
	// Filters is a filter over properties to narrow down the time series results.
	// This field is optional.
	Filters Filter
	// Metrics to be included in the time series information.
	// This field is optional.
	Metrics Metrics
	// Interval of time to consider for the time series result.
	// This field is optional.
	Interval TimeInterval
}

type TimeseriesResult []TimeseriesDataPoint