analytics

type ActiveUserSession struct {
	StartTime int64
	ID        string
	Bounce    bool
	TimeStamp string
}

type ActiveUserSessionES struct {
	ID          string
	UserSession UserSession
}

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

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

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

type AnalyticsPreferences struct {
	Enable *bool `json:"enable"`
}

type ClickRecord struct {
	Query     *string         `json:"query"`             // Optional
	QueryID   string          `json:"query_id"`          // Optional
	ClickType ClickType       `json:"click_type"`        // Optional
	ClickOn   *map[string]int `json:"click_on"`          // Required
	UserID    string          `json:"user_id,omitempty"` // Optional
	// TODO: Remove `event_data` in Next major version
	EventData    map[string]interface{}  `json:"event_data,omitempty"`    // Optional
	CustomEvents map[string]interface{}  `json:"custom_events,omitempty"` // Optional
	Meta         *map[string]interface{} `json:"meta"`
}

type ClickSummary struct {
	AvgClickPosition float64
	TotalConversions float64
	TotalClicks      float64
}

type ClickType int

type ConversionRecord struct {
	QueryID      string                  `json:"query_id"`      // Optional
	ConversionOn *[]string               `json:"conversion_on"` // Required
	Meta         *map[string]interface{} `json:"meta"`
}

type DetailedSummary struct {
	AvgBounceRate               float64 `json:"avg_bounce_rate"`
	AvgUserSessionDuration      float64 `json:"avg_user_session_duration"`
	AvgClickRate                float64 `json:"avg_click_rate"`
	AvgClickPosition            float64 `json:"avg_click_position"`
	AvgResultClickPosition      float64 `json:"avg_results_click_position"`
	AvgSuggestionsClickPosition float64 `json:"avg_suggestions_click_position"`
	AvgSuggestionsClickRate     float64 `json:"avg_suggestions_click_rate"`
	AvgConversionRate           float64 `json:"avg_conversion_rate"`
	TotalResultsCount           float64 `json:"total_results_count"`
	TotalSearches               float64 `json:"total_searches"`
	TotalUsers                  float64 `json:"total_users"`
	TotalUserSessions           float64 `json:"total_user_sessions"`
	TotalBounceUsers            float64 `json:"total_bounce_users"`
	TotalClicks                 float64 `json:"total_clicks"`
	TotalSuggestionsClicks      float64 `json:"total_suggestions_clicks"`
	TotalResultsClicks          float64 `json:"total_results_clicks"`
	TotalConversions            float64 `json:"total_conversions"`
	TotalNoResultsSearches      float64 `json:"total_no_results_searches"`
	NoResultsRate               float64 `json:"no_results_rate"`
	PopularSearches             float64 `json:"popular_searches"`
	AvgClickRatePopularSearches float64 `json:"avg_click_rate_popular_searches"`
	AvgQueryLength              float64 `json:"avg_query_length"`
	InternalServerErrors        float64 `json:"internal_server_errors"`
	BadRequestErrors            float64 `json:"bad_request_errors"`
	HighResponseTimeSearches    float64 `json:"high_response_time_searches"`
}

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

type FavoriteES struct {
	Id                     *string                 `json:"id,omitempty"`
	QueryId                *string                 `json:"query_id,omitempty"`
	FavoriteOn             *string                 `json:"favorite_on,omitempty"`
	Source                 *string                 `json:"source,omitempty"`
	UserId                 *string                 `json:"user_id,omitempty"`
	CustomEvents           *map[string]interface{} `json:"custom_events,omitempty"`
	CreatedAt              *int64                  `json:"created_at,omitempty"`
	UpdatedAt              *int64                  `json:"updated_at,omitempty"`
	TimeStamp              *string                 `json:"timestamp,omitempty"`
	SearchQuery            *string                 `json:"search_query,omitempty"`
	SearchQueryCharsLength *int                    `json:"search_characters_length,omitempty"`
	Meta                   *map[string]interface{} `json:"meta,omitempty"`
}

type FavoriteRequest struct {
	Id           *string                 `json:"id,omitempty"`
	QueryId      *string                 `json:"query_id,omitempty"`
	FavoriteOn   *string                 `json:"favorite_on,omitempty"`
	Source       *map[string]interface{} `json:"source,omitempty"`
	UserId       *string                 `json:"user_id,omitempty"`
	CustomEvents *map[string]interface{} `json:"custom_events,omitempty"`
	Meta         *map[string]interface{} `json:"meta,omitempty"`
}

type GetInsight struct {
	Summary       SummaryRecord
	Insights      []InsightResponseType
	SavedInsights []InsightResponseType
	ReadInsights  []InsightResponseType
}

type Insight struct {
	// Represents the insight title, must be a valid expression
	Title string `json:"title"`
	// Represents the insight description, must be a valid expression
	Description     string           `json:"description"`
	ShortLink       string           `json:"short_link"`
	Recommendations []Recommendation `json:"recommendations"`
	// expression from the `expr` package to evaluate the insight
	Condition string `json:"condition"`
}

type InsightConfigType struct {
	ID      InsightType `json:"id"`
	Insight Insight     `json:"insight"`
}

type InsightEnvironments struct {
	AvgBounceRate               string
	AvgUserSessionDuration      string
	AvgClickRate                string
	AvgClickPosition            string
	AvgResultClickPosition      string
	AvgSuggestionsClickPosition string
	AvgSuggestionsClickRate     string
	AvgConversionRate           string
	TotalResultsCount           string
	TotalSearches               string
	TotalUsers                  string
	TotalUserSessions           string
	TotalBounceUsers            string
	TotalClicks                 string
	TotalSuggestionsClicks      string
	TotalResultsClicks          string
	TotalConversions            string
	TotalNoResultsSearches      string
	NoResultsRate               string
	PopularSearches             string
	AvgClickRatePopularSearches string
	AvgQueryLength              string
	InternalServerErrors        string
	BadRequestErrors            string
	HighResponseTimeSearches    string
	ToFloat                     func(string) float64
	ToString                    func(float64, int) string
	FormatNumber                func(float64) string
}

type InsightReportAnalytics struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	Link        string `json:"link"`
}

type InsightResponse struct {
	/* Represents the recommendation title, for an example: "There are {value} no result searches".
	{value} is a variable which will be replaced by the actual value
	*/
	Title           string           `json:"title"`
	Description     string           `json:"description"`
	Recommendations []Recommendation `json:"recommendations"`
	ShortLink       string           `json:"short_link"`
}

type InsightResponseType struct {
	ID      InsightType     `json:"id"`
	Insight InsightResponse `json:"insight"`
}

type InsightStatus int

type InsightStatusEsDoc struct {
	Saved   []InsightType `json:"saved"`
	Read    []InsightType `json:"read"`
	Deleted []InsightType `json:"deleted"`
}

type InsightStatusRequest struct {
	ID     *InsightType  `json:"id"`
	Status InsightStatus `json:"status"`
}

type InsightType int

type InsightsEnvironments struct {
	DateRange        string                   `json:"date_range"` // format Apr 1 - Apr 30
	NumberOfInsights int                      `json:"number_of_insights"`
	Insights         []InsightReportAnalytics `json:"insights"`
}

type Link struct {
	ShortLink string
	LongLink  string
}

type Links struct {
	Language          Link
	Rules             Link
	SearchSettings    Link
	Synonyms          Link
	QuerySuggestions  Link
	ResultSettings    Link
	IndexSettings     Link
	RequestLogs       Link
	NoResultsSearches Link
	PopularSearches   Link
}

type Location struct {
	Country     string
	City        string
	Coordinates string
}

type MappingsMigration struct {
	NewMapping string
	// contains filtered or unexported fields
}

type QueryFilter struct {
	Type       string // Valid types are `exists` => We can add new types as per need
	Field      string
	NestedPath string
}

type QueryParams struct {
	From     string
	To       string
	Size     int
	Timezone string
}

type RecentDocument struct {
	DocumentId *string                 `json:"document_id"`
	Source     *map[string]interface{} `json:"source"`
	Users      *map[string]int64       `json:"users"`
	Index      *string                 `json:"index"`
}

type RecentDocumentPublic struct {
	DocumentId   *string                 `json:"document_id"`
	UserId       *string                 `json:"user_id"`
	Index        *string                 `json:"index"`
	Source       *map[string]interface{} `json:"source"`
	LastAccessed *int64                  `json:"last_accessed,omitempty"`
}

type Recommendation struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	// Represents the short link for e.g '/cluster/no-results-searches'
	ShortLink string `json:"short_link"`
	// Represents the full link for e.g 'https://dash.reactivesearch.io/cluster/no-results-searches'
	LongLink string `json:"long_link"`
}

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

type ReportAnalyticsRequest struct {
	Summary             SummaryRecord        `json:"summary"`
	SummaryComparison   SummaryComparison    `json:"summary_comparison"`
	Insights            InsightsEnvironments `json:"insights"`
	Users               []string             `json:"users"`
	FeatureCustomEvents bool                 `json:"feature_custom_events"`
}

type RequestHIT struct {
	ID    string `json:"id"`
	Index string `json:"index"`
}

type SavedSearchES struct {
	QueryId                *string                 `json:"query_id,omitempty"`
	SavedSearchId          *string                 `json:"save_search_id,omitempty"`
	SavedSearchName        *string                 `json:"save_search_name,omitempty"`
	SavedSearchMeta        *map[string]interface{} `json:"save_search_meta,omitempty"`
	UserId                 *string                 `json:"user_id,omitempty"`
	CustomEvents           *map[string]interface{} `json:"custom_events,omitempty"`
	SearchState            querytranslate.Endpoint `json:"search_state,omitempty"`
	CreatedAt              *int64                  `json:"created_at,omitempty"`
	UpdatedAt              *int64                  `json:"updated_at,omitempty"`
	TimeStamp              *string                 `json:"timestamp,omitempty"`
	SearchQuery            *string                 `json:"search_query,omitempty"`
	SearchQueryCharsLength *int                    `json:"search_characters_length,omitempty"`
}

type SavedSearchRequest struct {
	QueryId         *string                 `json:"query_id,omitempty"`
	SavedSearchId   *string                 `json:"save_search_id,omitempty"`
	SavedSearchName *string                 `json:"save_search_name,omitempty"`
	SavedSearchMeta *map[string]interface{} `json:"save_search_meta,omitempty"`
	UserId          *string                 `json:"user_id,omitempty"`
	CustomEvents    *map[string]interface{} `json:"custom_events,omitempty"`
}

type SavedSearchesFilters struct {
	FromTimeStamp string
	ToTimeStamp   string
	TimeZone      string
	Size          int
	MinChars      *int
	CustomEvents  map[string]interface{}
}

type SearchRecord struct {
	Query       *string            `json:"query"`                 // Required
	QueryID     string             `json:"query_id"`              // Optional
	Filters     *map[string]string `json:"filters,omitempty"`     // Optional
	Impressions *[]RequestHIT      `json:"impressions,omitempty"` // Optional
	TotalHits   *int64             `json:"total_hits,omitempty"`  // Optional
	UserID      string             `json:"user_id,omitempty"`     // Optional
	// TODO: Remove `event_data` in Next major version
	EventData    map[string]interface{}  `json:"event_data,omitempty"`    // Optional
	CustomEvents map[string]interface{}  `json:"custom_events,omitempty"` // Optional
	Meta         *map[string]interface{} `json:"meta"`
}

type SummaryComparison struct {
	AvgBounceRateComparison               float64 `json:"avg_bounce_rate_sc"`
	AvgBounceRatePrevious                 float64 `json:"avg_bounce_rate_prev"`
	AvgUserSessionDurationComparison      float64 `json:"avg_user_session_duration_sc"`
	AvgUserSessionDurationPrevious        float64 `json:"avg_user_session_duration_prev"`
	AvgClickRateComparison                float64 `json:"avg_click_rate_sc"`
	AvgClickRatePrevious                  float64 `json:"avg_click_rate_prev"`
	AvgClickPositionComparison            float64 `json:"avg_click_position_sc"`
	AvgClickPositionPrevious              float64 `json:"avg_click_position_prev"`
	AvgResultClickPositionComparison      float64 `json:"avg_results_click_position_sc"`
	AvgResultClickPositionPrevious        float64 `json:"avg_results_click_position_prev"`
	AvgSuggestionsClickPositionComparison float64 `json:"avg_suggestions_click_position_sc"`
	AvgSuggestionsClickPositionPrevious   float64 `json:"avg_suggestions_click_position_prev"`
	AvgSuggestionsClickRateComparison     float64 `json:"avg_suggestions_click_rate_sc"`
	AvgSuggestionsClickRatePrevious       float64 `json:"avg_suggestions_click_rate_prev"`
	AvgConversionRateComparison           float64 `json:"avg_conversion_rate_sc"`
	AvgConversionRatePrevious             float64 `json:"avg_conversion_rate_prev"`
	TotalResultsCountComparison           float64 `json:"total_results_count_sc"`
	TotalResultsCountPrevious             float64 `json:"total_results_count_prev"`
	TotalSearchesComparison               float64 `json:"total_searches_sc"`
	TotalSearchesPrevious                 float64 `json:"total_searches_prev"`
	TotalUsersComparison                  float64 `json:"total_users_sc"`
	TotalUsersPrevious                    float64 `json:"total_users_prev"`
	TotalUserSessionsComparison           float64 `json:"total_user_sessions_sc"`
	TotalUserSessionsPrevious             float64 `json:"total_user_sessions_prev"`
	TotalBounceUsersComparison            float64 `json:"total_bounce_users_sc"`
	TotalBounceUsersPrevious              float64 `json:"total_bounce_users_prev"`
	TotalClicksComparison                 float64 `json:"total_clicks_sc"`
	TotalClicksPrevious                   float64 `json:"total_clicks_prev"`
	TotalSuggestionsClicksComparison      float64 `json:"total_suggestions_clicks_sc"`
	TotalSuggestionsClicksPrevious        float64 `json:"total_suggestions_clicks_prev"`
	TotalResultsClicksComparison          float64 `json:"total_results_clicks_sc"`
	TotalResultsClicksPrevious            float64 `json:"total_results_clicks_prev"`
	TotalConversionsComparison            float64 `json:"total_conversions_sc"`
	TotalConversionsPrevious              float64 `json:"total_conversions_prev"`
	TotalNoResultsSearchesComparison      float64 `json:"total_no_results_searches_sc"`
	TotalNoResultsSearchesPrevious        float64 `json:"total_no_results_searches_prev"`
	NoResultsRateComparison               float64 `json:"no_results_rate_sc"`
	NoResultsRatePrevious                 float64 `json:"no_results_rate_prev"`
}

type SummaryRecord struct {
	AvgBounceRate               float64 `json:"avg_bounce_rate"`
	AvgUserSessionDuration      float64 `json:"avg_user_session_duration"`
	AvgClickRate                float64 `json:"avg_click_rate"`
	AvgClickPosition            float64 `json:"avg_click_position"`
	AvgResultClickPosition      float64 `json:"avg_results_click_position"`
	AvgSuggestionsClickPosition float64 `json:"avg_suggestions_click_position"`
	AvgSuggestionsClickRate     float64 `json:"avg_suggestions_click_rate"`
	AvgConversionRate           float64 `json:"avg_conversion_rate"`
	TotalResultsCount           float64 `json:"total_results_count"`
	TotalSearches               float64 `json:"total_searches"`
	TotalUsers                  float64 `json:"total_users"`
	TotalUserSessions           float64 `json:"total_user_sessions"`
	TotalBounceUsers            float64 `json:"total_bounce_users"`
	TotalClicks                 float64 `json:"total_clicks"`
	TotalSuggestionsClicks      float64 `json:"total_suggestions_clicks"`
	TotalResultsClicks          float64 `json:"total_results_clicks"`
	TotalConversions            float64 `json:"total_conversions"`
	TotalNoResultsSearches      float64 `json:"total_no_results_searches"`
	NoResultsRate               float64 `json:"no_results_rate"`
}

type SummaryResponse struct {
	Summary          SummaryRecord  `json:"summary"`
	CompateTimeframe *SummaryRecord `json:"compare_timeframe,omitempty"`
}

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

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

type UpdateConfig struct {
	DocID        string
	Script       string
	Record       map[string]interface{}
	ScriptParams map[string]interface{}
}

type User struct {
	Email string `json:"email"`
}

type UserSession struct {
	StartTime           *int64    `json:"start_time,omitempty"`
	LastInteractionTime *int64    `json:"last_interaction_time,omitempty"`
	Duration            *int64    `json:"duration,omitempty"`
	UserID              *string   `json:"user_id,omitempty"`
	Indices             *[]string `json:"indices,omitempty"`
	Bounce              *bool     `json:"bounce,omitempty"`
	TimeStamp           string    `json:"timestamp,omitempty"`
	IP                  *string   `json:"ip,omitempty"`
}

type UserSessionMappingsMigration struct {
	NewMapping string
	// contains filtered or unexported fields
}