analytics

package
v4.10.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 18, 2024 License: MIT Imports: 18 Imported by: 0

Documentation

Overview

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source 
var AllowedDirectionEnumValues = []Direction{
	"asc",
	"desc",
}

All allowed values of Direction enum.

View Source 
var AllowedOperatorEnumValues = []Operator{
	":",
	"<",
	"<=",
	"=",
	"!=",
	">",
	">=",
}

All allowed values of Operator enum.

View Source 
var AllowedOrderByEnumValues = []OrderBy{
	"searchCount",
	"clickThroughRate",
	"conversionRate",
	"averageClickPosition",
}

All allowed values of OrderBy enum.

Functions

func WithContext 

func WithContext(ctx context.Context) requestOption

func WithHeaderParam 

func WithHeaderParam(key string, value any) requestOption

func WithQueryParam 

func WithQueryParam(key string, value any) requestOption

Types

type APIClient 

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

APIClient manages communication with the Analytics API API v2.0.0 In most cases there should be only one, shared, APIClient.

func NewClient 

func NewClient(appID, apiKey string, region Region) (*APIClient, error)

NewClient creates a new API client with appID, apiKey and region.

func NewClientWithConfig 

func NewClientWithConfig(cfg AnalyticsConfiguration) (*APIClient, error)

NewClientWithConfig creates a new API client with the given configuration to fully customize the client behaviour.

func (*APIClient) AddDefaultHeader 

func (c *APIClient) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request.

func (*APIClient) CustomDelete 

func (c *APIClient) CustomDelete(r ApiCustomDeleteRequest, opts ...RequestOption) (*map[string]any, error)

CustomDelete casts the HTTP response body to a defined struct.

This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomDeleteRequest with parameters below. 

@param path string - Path of the endpoint, anything after \"/1\" must be specified.
@param parameters map[string]any - Query parameters to apply to the current query.
@return map[string]any

func (*APIClient) CustomDeleteWithHTTPInfo 

func (c *APIClient) CustomDeleteWithHTTPInfo(r ApiCustomDeleteRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomDelete calls the API and returns the raw response from it. 

  This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomDeleteRequest with parameters below.
  @param path string - Path of the endpoint, anything after \"/1\" must be specified.
  @param parameters map[string]any - Query parameters to apply to the current query.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomGet 

func (c *APIClient) CustomGet(r ApiCustomGetRequest, opts ...RequestOption) (*map[string]any, error)

CustomGet casts the HTTP response body to a defined struct.

This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomGetRequest with parameters below. 

@param path string - Path of the endpoint, anything after \"/1\" must be specified.
@param parameters map[string]any - Query parameters to apply to the current query.
@return map[string]any

func (*APIClient) CustomGetWithHTTPInfo 

func (c *APIClient) CustomGetWithHTTPInfo(r ApiCustomGetRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomGet calls the API and returns the raw response from it. 

  This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomGetRequest with parameters below.
  @param path string - Path of the endpoint, anything after \"/1\" must be specified.
  @param parameters map[string]any - Query parameters to apply to the current query.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomPost 

func (c *APIClient) CustomPost(r ApiCustomPostRequest, opts ...RequestOption) (*map[string]any, error)

CustomPost casts the HTTP response body to a defined struct.

This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPostRequest with parameters below. 

@param path string - Path of the endpoint, anything after \"/1\" must be specified.
@param parameters map[string]any - Query parameters to apply to the current query.
@param body map[string]any - Parameters to send with the custom request.
@return map[string]any

func (*APIClient) CustomPostWithHTTPInfo 

func (c *APIClient) CustomPostWithHTTPInfo(r ApiCustomPostRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomPost calls the API and returns the raw response from it. 

  This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPostRequest with parameters below.
  @param path string - Path of the endpoint, anything after \"/1\" must be specified.
  @param parameters map[string]any - Query parameters to apply to the current query.
  @param body map[string]any - Parameters to send with the custom request.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomPut 

func (c *APIClient) CustomPut(r ApiCustomPutRequest, opts ...RequestOption) (*map[string]any, error)

CustomPut casts the HTTP response body to a defined struct.

This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPutRequest with parameters below. 

@param path string - Path of the endpoint, anything after \"/1\" must be specified.
@param parameters map[string]any - Query parameters to apply to the current query.
@param body map[string]any - Parameters to send with the custom request.
@return map[string]any

func (*APIClient) CustomPutWithHTTPInfo 

func (c *APIClient) CustomPutWithHTTPInfo(r ApiCustomPutRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomPut calls the API and returns the raw response from it. 

  This method allow you to send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPutRequest with parameters below.
  @param path string - Path of the endpoint, anything after \"/1\" must be specified.
  @param parameters map[string]any - Query parameters to apply to the current query.
  @param body map[string]any - Parameters to send with the custom request.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetAddToCartRate 

func (c *APIClient) GetAddToCartRate(r ApiGetAddToCartRateRequest, opts ...RequestOption) (*GetAddToCartRateResponse, error)

GetAddToCartRate casts the HTTP response body to a defined struct.

Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetAddToCartRateRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetAddToCartRateResponse

func (*APIClient) GetAddToCartRateWithHTTPInfo 

func (c *APIClient) GetAddToCartRateWithHTTPInfo(r ApiGetAddToCartRateRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetAddToCartRate calls the API and returns the raw response from it. 

Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetAddToCartRateRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetAverageClickPosition 

func (c *APIClient) GetAverageClickPosition(r ApiGetAverageClickPositionRequest, opts ...RequestOption) (*GetAverageClickPositionResponse, error)

GetAverageClickPosition casts the HTTP response body to a defined struct.

Retrieves the average click position of your search results, including a daily breakdown.

The average click position is the average of all clicked search results' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetAverageClickPositionRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetAverageClickPositionResponse

func (*APIClient) GetAverageClickPositionWithHTTPInfo 

func (c *APIClient) GetAverageClickPositionWithHTTPInfo(r ApiGetAverageClickPositionRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetAverageClickPosition calls the API and returns the raw response from it. 

Retrieves the average click position of your search results, including a daily breakdown.

The average click position is the average of all clicked search results' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetAverageClickPositionRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetClickPositions 

func (c *APIClient) GetClickPositions(r ApiGetClickPositionsRequest, opts ...RequestOption) (*GetClickPositionsResponse, error)

GetClickPositions casts the HTTP response body to a defined struct.

Retrieves the positions in the search results and their associated number of clicks.

This lets you check how many clicks the first, second, or tenth search results receive.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetClickPositionsRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetClickPositionsResponse

func (*APIClient) GetClickPositionsWithHTTPInfo 

func (c *APIClient) GetClickPositionsWithHTTPInfo(r ApiGetClickPositionsRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetClickPositions calls the API and returns the raw response from it. 

Retrieves the positions in the search results and their associated number of clicks.

This lets you check how many clicks the first, second, or tenth search results receive. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetClickPositionsRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetClickThroughRate 

func (c *APIClient) GetClickThroughRate(r ApiGetClickThroughRateRequest, opts ...RequestOption) (*GetClickThroughRateResponse, error)

GetClickThroughRate casts the HTTP response body to a defined struct.

Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown

By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetClickThroughRateRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetClickThroughRateResponse

func (*APIClient) GetClickThroughRateWithHTTPInfo 

func (c *APIClient) GetClickThroughRateWithHTTPInfo(r ApiGetClickThroughRateRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetClickThroughRate calls the API and returns the raw response from it. 

Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown

By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetClickThroughRateRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetConfiguration 

func (c *APIClient) GetConfiguration() *AnalyticsConfiguration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior.

func (*APIClient) GetConversionRate 

func (c *APIClient) GetConversionRate(r ApiGetConversionRateRequest, opts ...RequestOption) (*GetConversionRateResponse, error)

GetConversionRate casts the HTTP response body to a defined struct.

Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetConversionRateRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetConversionRateResponse

func (*APIClient) GetConversionRateWithHTTPInfo 

func (c *APIClient) GetConversionRateWithHTTPInfo(r ApiGetConversionRateRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetConversionRate calls the API and returns the raw response from it. 

Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetConversionRateRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetNoClickRate 

func (c *APIClient) GetNoClickRate(r ApiGetNoClickRateRequest, opts ...RequestOption) (*GetNoClickRateResponse, error)

GetNoClickRate casts the HTTP response body to a defined struct.

Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetNoClickRateRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetNoClickRateResponse

func (*APIClient) GetNoClickRateWithHTTPInfo 

func (c *APIClient) GetNoClickRateWithHTTPInfo(r ApiGetNoClickRateRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetNoClickRate calls the API and returns the raw response from it. 

Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetNoClickRateRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetNoResultsRate 

func (c *APIClient) GetNoResultsRate(r ApiGetNoResultsRateRequest, opts ...RequestOption) (*GetNoResultsRateResponse, error)

GetNoResultsRate casts the HTTP response body to a defined struct.

Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetNoResultsRateRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetNoResultsRateResponse

func (*APIClient) GetNoResultsRateWithHTTPInfo 

func (c *APIClient) GetNoResultsRateWithHTTPInfo(r ApiGetNoResultsRateRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetNoResultsRate calls the API and returns the raw response from it. 

Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetNoResultsRateRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetPurchaseRate 

func (c *APIClient) GetPurchaseRate(r ApiGetPurchaseRateRequest, opts ...RequestOption) (*GetPurchaseRateResponse, error)

GetPurchaseRate casts the HTTP response body to a defined struct.

Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetPurchaseRateRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetPurchaseRateResponse

func (*APIClient) GetPurchaseRateWithHTTPInfo 

func (c *APIClient) GetPurchaseRateWithHTTPInfo(r ApiGetPurchaseRateRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetPurchaseRate calls the API and returns the raw response from it. 

Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetPurchaseRateRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetRevenue 

func (c *APIClient) GetRevenue(r ApiGetRevenueRequest, opts ...RequestOption) (*GetRevenue, error)

GetRevenue casts the HTTP response body to a defined struct.

Retrieves revenue-related metrics, such as the total revenue or the average order value.

To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetRevenueRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetRevenue

func (*APIClient) GetRevenueWithHTTPInfo 

func (c *APIClient) GetRevenueWithHTTPInfo(r ApiGetRevenueRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetRevenue calls the API and returns the raw response from it. 

Retrieves revenue-related metrics, such as the total revenue or the average order value.

To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetRevenueRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetSearchesCount 

func (c *APIClient) GetSearchesCount(r ApiGetSearchesCountRequest, opts ...RequestOption) (*GetSearchesCountResponse, error)

GetSearchesCount casts the HTTP response body to a defined struct.

Retrieves the number of searches within a time range, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetSearchesCountRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetSearchesCountResponse

func (*APIClient) GetSearchesCountWithHTTPInfo 

func (c *APIClient) GetSearchesCountWithHTTPInfo(r ApiGetSearchesCountRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetSearchesCount calls the API and returns the raw response from it. 

Retrieves the number of searches within a time range, including a daily breakdown.

By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetSearchesCountRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetSearchesNoClicks 

func (c *APIClient) GetSearchesNoClicks(r ApiGetSearchesNoClicksRequest, opts ...RequestOption) (*GetSearchesNoClicksResponse, error)

GetSearchesNoClicks casts the HTTP response body to a defined struct.

Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetSearchesNoClicksRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param limit int32 - Number of items to return.
@param offset int32 - Position of the first item to return.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetSearchesNoClicksResponse

func (*APIClient) GetSearchesNoClicksWithHTTPInfo 

func (c *APIClient) GetSearchesNoClicksWithHTTPInfo(r ApiGetSearchesNoClicksRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetSearchesNoClicks calls the API and returns the raw response from it. 

  Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetSearchesNoClicksRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param limit int32 - Number of items to return.
  @param offset int32 - Position of the first item to return.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetSearchesNoResults 

func (c *APIClient) GetSearchesNoResults(r ApiGetSearchesNoResultsRequest, opts ...RequestOption) (*GetSearchesNoResultsResponse, error)

GetSearchesNoResults casts the HTTP response body to a defined struct.

Retrieves the most popular searches that didn't return any results.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetSearchesNoResultsRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param limit int32 - Number of items to return.
@param offset int32 - Position of the first item to return.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetSearchesNoResultsResponse

func (*APIClient) GetSearchesNoResultsWithHTTPInfo 

func (c *APIClient) GetSearchesNoResultsWithHTTPInfo(r ApiGetSearchesNoResultsRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetSearchesNoResults calls the API and returns the raw response from it. 

  Retrieves the most popular searches that didn't return any results.

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetSearchesNoResultsRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param limit int32 - Number of items to return.
  @param offset int32 - Position of the first item to return.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetStatus 

func (c *APIClient) GetStatus(r ApiGetStatusRequest, opts ...RequestOption) (*GetStatusResponse, error)

GetStatus casts the HTTP response body to a defined struct.

Retrieves the time when the Analytics data for the specified index was last updated.

The Analytics data is updated every 5 minutes.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetStatusRequest with parameters below. 

@param index string - Index name.
@return GetStatusResponse

func (*APIClient) GetStatusWithHTTPInfo 

func (c *APIClient) GetStatusWithHTTPInfo(r ApiGetStatusRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetStatus calls the API and returns the raw response from it. 

Retrieves the time when the Analytics data for the specified index was last updated.

The Analytics data is updated every 5 minutes. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetStatusRequest with parameters below.
  @param index string - Index name.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetTopCountries 

func (c *APIClient) GetTopCountries(r ApiGetTopCountriesRequest, opts ...RequestOption) (*GetTopCountriesResponse, error)

GetTopCountries casts the HTTP response body to a defined struct.

Retrieves the countries with the most searches to your index.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetTopCountriesRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param limit int32 - Number of items to return.
@param offset int32 - Position of the first item to return.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopCountriesResponse

func (*APIClient) GetTopCountriesWithHTTPInfo 

func (c *APIClient) GetTopCountriesWithHTTPInfo(r ApiGetTopCountriesRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetTopCountries calls the API and returns the raw response from it. 

  Retrieves the countries with the most searches to your index.

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetTopCountriesRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param limit int32 - Number of items to return.
  @param offset int32 - Position of the first item to return.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetTopFilterAttributes 

func (c *APIClient) GetTopFilterAttributes(r ApiGetTopFilterAttributesRequest, opts ...RequestOption) (*GetTopFilterAttributesResponse, error)

GetTopFilterAttributes casts the HTTP response body to a defined struct.

Retrieves the most frequently used filter attributes.

These are attributes of your records that you included in the `attributesForFaceting` setting.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetTopFilterAttributesRequest with parameters below. 

@param index string - Index name.
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param limit int32 - Number of items to return.
@param offset int32 - Position of the first item to return.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopFilterAttributesResponse

func (*APIClient) GetTopFilterAttributesWithHTTPInfo 

func (c *APIClient) GetTopFilterAttributesWithHTTPInfo(r ApiGetTopFilterAttributesRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetTopFilterAttributes calls the API and returns the raw response from it. 

Retrieves the most frequently used filter attributes.

These are attributes of your records that you included in the `attributesForFaceting` setting. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetTopFilterAttributesRequest with parameters below.
  @param index string - Index name.
  @param search string - Search query.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param limit int32 - Number of items to return.
  @param offset int32 - Position of the first item to return.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetTopFilterForAttribute 

func (c *APIClient) GetTopFilterForAttribute(r ApiGetTopFilterForAttributeRequest, opts ...RequestOption) (*GetTopFilterForAttributeResponse, error)

GetTopFilterForAttribute casts the HTTP response body to a defined struct.

Retrieves the most frequent filter (facet) values for a filter attribute.

These are attributes of your records that you included in the `attributesForFaceting` setting.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetTopFilterForAttributeRequest with parameters below. 

@param attribute string - Attribute name.
@param index string - Index name.
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param limit int32 - Number of items to return.
@param offset int32 - Position of the first item to return.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopFilterForAttributeResponse

func (*APIClient) GetTopFilterForAttributeWithHTTPInfo 

func (c *APIClient) GetTopFilterForAttributeWithHTTPInfo(r ApiGetTopFilterForAttributeRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetTopFilterForAttribute calls the API and returns the raw response from it. 

Retrieves the most frequent filter (facet) values for a filter attribute.

These are attributes of your records that you included in the `attributesForFaceting` setting. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetTopFilterForAttributeRequest with parameters below.
  @param attribute string - Attribute name.
  @param index string - Index name.
  @param search string - Search query.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param limit int32 - Number of items to return.
  @param offset int32 - Position of the first item to return.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetTopFiltersNoResults 

func (c *APIClient) GetTopFiltersNoResults(r ApiGetTopFiltersNoResultsRequest, opts ...RequestOption) (*GetTopFiltersNoResultsResponse, error)

GetTopFiltersNoResults casts the HTTP response body to a defined struct.

Retrieves the most frequently used filters for a search that didn't return any results.

To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetTopFiltersNoResultsRequest with parameters below. 

@param index string - Index name.
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param limit int32 - Number of items to return.
@param offset int32 - Position of the first item to return.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopFiltersNoResultsResponse

func (*APIClient) GetTopFiltersNoResultsWithHTTPInfo 

func (c *APIClient) GetTopFiltersNoResultsWithHTTPInfo(r ApiGetTopFiltersNoResultsRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetTopFiltersNoResults calls the API and returns the raw response from it. 

Retrieves the most frequently used filters for a search that didn't return any results.

To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetTopFiltersNoResultsRequest with parameters below.
  @param index string - Index name.
  @param search string - Search query.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param limit int32 - Number of items to return.
  @param offset int32 - Position of the first item to return.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetTopHits 

func (c *APIClient) GetTopHits(r ApiGetTopHitsRequest, opts ...RequestOption) (*GetTopHitsResponse, error)

GetTopHits casts the HTTP response body to a defined struct.

Retrieves the object IDs of the most frequent search results.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetTopHitsRequest with parameters below. 

@param index string - Index name.
@param search string - Search query.
@param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response.
@param revenueAnalytics bool - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param limit int32 - Number of items to return.
@param offset int32 - Position of the first item to return.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopHitsResponse

func (*APIClient) GetTopHitsWithHTTPInfo 

func (c *APIClient) GetTopHitsWithHTTPInfo(r ApiGetTopHitsRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetTopHits calls the API and returns the raw response from it. 

  Retrieves the object IDs of the most frequent search results.

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetTopHitsRequest with parameters below.
  @param index string - Index name.
  @param search string - Search query.
  @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response.
  @param revenueAnalytics bool - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param limit int32 - Number of items to return.
  @param offset int32 - Position of the first item to return.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetTopSearches 

func (c *APIClient) GetTopSearches(r ApiGetTopSearchesRequest, opts ...RequestOption) (*GetTopSearchesResponse, error)

GetTopSearches casts the HTTP response body to a defined struct.

Returns the most popular search terms.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetTopSearchesRequest with parameters below. 

@param index string - Index name.
@param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response.
@param revenueAnalytics bool - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param orderBy OrderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
@param direction Direction - Sorting direction of the results: ascending or descending.
@param limit int32 - Number of items to return.
@param offset int32 - Position of the first item to return.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopSearchesResponse

func (*APIClient) GetTopSearchesWithHTTPInfo 

func (c *APIClient) GetTopSearchesWithHTTPInfo(r ApiGetTopSearchesRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetTopSearches calls the API and returns the raw response from it. 

  Returns the most popular search terms.

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetTopSearchesRequest with parameters below.
  @param index string - Index name.
  @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response.
  @param revenueAnalytics bool - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param orderBy OrderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
  @param direction Direction - Sorting direction of the results: ascending or descending.
  @param limit int32 - Number of items to return.
  @param offset int32 - Position of the first item to return.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetUsersCount 

func (c *APIClient) GetUsersCount(r ApiGetUsersCountRequest, opts ...RequestOption) (*GetUsersCountResponse, error)

GetUsersCount casts the HTTP response body to a defined struct.

Retrieves the number of unique users within a time range, including a daily breakdown.

Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number.

By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

  • analytics

Request can be constructed by NewApiGetUsersCountRequest with parameters below. 

@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetUsersCountResponse

func (*APIClient) GetUsersCountWithHTTPInfo 

func (c *APIClient) GetUsersCountWithHTTPInfo(r ApiGetUsersCountRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetUsersCount calls the API and returns the raw response from it. 

Retrieves the number of unique users within a time range, including a daily breakdown.

Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number.

By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day. 

    Required API Key ACLs:
    - analytics

Request can be constructed by NewApiGetUsersCountRequest with parameters below.
  @param index string - Index name.
  @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
  @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
  @param tags string - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) NewApiCustomDeleteRequest 

func (c *APIClient) NewApiCustomDeleteRequest(path string) ApiCustomDeleteRequest

NewApiCustomDeleteRequest creates an instance of the ApiCustomDeleteRequest to be used for the API call.

func (*APIClient) NewApiCustomGetRequest 

func (c *APIClient) NewApiCustomGetRequest(path string) ApiCustomGetRequest

NewApiCustomGetRequest creates an instance of the ApiCustomGetRequest to be used for the API call.

func (*APIClient) NewApiCustomPostRequest 

func (c *APIClient) NewApiCustomPostRequest(path string) ApiCustomPostRequest

NewApiCustomPostRequest creates an instance of the ApiCustomPostRequest to be used for the API call.

func (*APIClient) NewApiCustomPutRequest 

func (c *APIClient) NewApiCustomPutRequest(path string) ApiCustomPutRequest

NewApiCustomPutRequest creates an instance of the ApiCustomPutRequest to be used for the API call.

func (*APIClient) NewApiGetAddToCartRateRequest 

func (c *APIClient) NewApiGetAddToCartRateRequest(index string) ApiGetAddToCartRateRequest

NewApiGetAddToCartRateRequest creates an instance of the ApiGetAddToCartRateRequest to be used for the API call.

func (*APIClient) NewApiGetAverageClickPositionRequest 

func (c *APIClient) NewApiGetAverageClickPositionRequest(index string) ApiGetAverageClickPositionRequest

NewApiGetAverageClickPositionRequest creates an instance of the ApiGetAverageClickPositionRequest to be used for the API call.

func (*APIClient) NewApiGetClickPositionsRequest 

func (c *APIClient) NewApiGetClickPositionsRequest(index string) ApiGetClickPositionsRequest

NewApiGetClickPositionsRequest creates an instance of the ApiGetClickPositionsRequest to be used for the API call.

func (*APIClient) NewApiGetClickThroughRateRequest 

func (c *APIClient) NewApiGetClickThroughRateRequest(index string) ApiGetClickThroughRateRequest

NewApiGetClickThroughRateRequest creates an instance of the ApiGetClickThroughRateRequest to be used for the API call.

func (*APIClient) NewApiGetConversionRateRequest 

func (c *APIClient) NewApiGetConversionRateRequest(index string) ApiGetConversionRateRequest

NewApiGetConversionRateRequest creates an instance of the ApiGetConversionRateRequest to be used for the API call.

func (*APIClient) NewApiGetNoClickRateRequest 

func (c *APIClient) NewApiGetNoClickRateRequest(index string) ApiGetNoClickRateRequest

NewApiGetNoClickRateRequest creates an instance of the ApiGetNoClickRateRequest to be used for the API call.

func (*APIClient) NewApiGetNoResultsRateRequest 

func (c *APIClient) NewApiGetNoResultsRateRequest(index string) ApiGetNoResultsRateRequest

NewApiGetNoResultsRateRequest creates an instance of the ApiGetNoResultsRateRequest to be used for the API call.

func (*APIClient) NewApiGetPurchaseRateRequest 

func (c *APIClient) NewApiGetPurchaseRateRequest(index string) ApiGetPurchaseRateRequest

NewApiGetPurchaseRateRequest creates an instance of the ApiGetPurchaseRateRequest to be used for the API call.

func (*APIClient) NewApiGetRevenueRequest 

func (c *APIClient) NewApiGetRevenueRequest(index string) ApiGetRevenueRequest

NewApiGetRevenueRequest creates an instance of the ApiGetRevenueRequest to be used for the API call.

func (*APIClient) NewApiGetSearchesCountRequest 

func (c *APIClient) NewApiGetSearchesCountRequest(index string) ApiGetSearchesCountRequest

NewApiGetSearchesCountRequest creates an instance of the ApiGetSearchesCountRequest to be used for the API call.

func (*APIClient) NewApiGetSearchesNoClicksRequest 

func (c *APIClient) NewApiGetSearchesNoClicksRequest(index string) ApiGetSearchesNoClicksRequest

NewApiGetSearchesNoClicksRequest creates an instance of the ApiGetSearchesNoClicksRequest to be used for the API call.

func (*APIClient) NewApiGetSearchesNoResultsRequest 

func (c *APIClient) NewApiGetSearchesNoResultsRequest(index string) ApiGetSearchesNoResultsRequest

NewApiGetSearchesNoResultsRequest creates an instance of the ApiGetSearchesNoResultsRequest to be used for the API call.

func (*APIClient) NewApiGetStatusRequest 

func (c *APIClient) NewApiGetStatusRequest(index string) ApiGetStatusRequest

NewApiGetStatusRequest creates an instance of the ApiGetStatusRequest to be used for the API call.

func (*APIClient) NewApiGetTopCountriesRequest 

func (c *APIClient) NewApiGetTopCountriesRequest(index string) ApiGetTopCountriesRequest

NewApiGetTopCountriesRequest creates an instance of the ApiGetTopCountriesRequest to be used for the API call.

func (*APIClient) NewApiGetTopFilterAttributesRequest 

func (c *APIClient) NewApiGetTopFilterAttributesRequest(index string) ApiGetTopFilterAttributesRequest

NewApiGetTopFilterAttributesRequest creates an instance of the ApiGetTopFilterAttributesRequest to be used for the API call.

func (*APIClient) NewApiGetTopFilterForAttributeRequest 

func (c *APIClient) NewApiGetTopFilterForAttributeRequest(attribute string, index string) ApiGetTopFilterForAttributeRequest

NewApiGetTopFilterForAttributeRequest creates an instance of the ApiGetTopFilterForAttributeRequest to be used for the API call.

func (*APIClient) NewApiGetTopFiltersNoResultsRequest 

func (c *APIClient) NewApiGetTopFiltersNoResultsRequest(index string) ApiGetTopFiltersNoResultsRequest

NewApiGetTopFiltersNoResultsRequest creates an instance of the ApiGetTopFiltersNoResultsRequest to be used for the API call.

func (*APIClient) NewApiGetTopHitsRequest 

func (c *APIClient) NewApiGetTopHitsRequest(index string) ApiGetTopHitsRequest

NewApiGetTopHitsRequest creates an instance of the ApiGetTopHitsRequest to be used for the API call.

func (*APIClient) NewApiGetTopSearchesRequest 

func (c *APIClient) NewApiGetTopSearchesRequest(index string) ApiGetTopSearchesRequest

NewApiGetTopSearchesRequest creates an instance of the ApiGetTopSearchesRequest to be used for the API call.

func (*APIClient) NewApiGetUsersCountRequest 

func (c *APIClient) NewApiGetUsersCountRequest(index string) ApiGetUsersCountRequest

NewApiGetUsersCountRequest creates an instance of the ApiGetUsersCountRequest to be used for the API call.

func (*APIClient) SetClientApiKey added in v4.3.0 

func (c *APIClient) SetClientApiKey(apiKey string) error

Allow update of stored API key used to authenticate requests.

type APIError 

type APIError struct {
	Message              string
	Status               int
	AdditionalProperties map[string]any
}

func (APIError) Error 

func (e APIError) Error() string

func (APIError) MarshalJSON added in v4.8.0 

func (o APIError) MarshalJSON() ([]byte, error)

func (*APIError) UnmarshalJSON added in v4.8.0 

func (o *APIError) UnmarshalJSON(bytes []byte) error

type AnalyticsConfiguration 

type AnalyticsConfiguration struct {
	transport.Configuration

	Region Region
}

AnalyticsConfiguration stores the configuration of the API client.

type ApiCustomDeleteRequest 

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

ApiCustomDeleteRequest represents the request with all the parameters for the API call.

func (*ApiCustomDeleteRequest) UnmarshalJSON 

func (r *ApiCustomDeleteRequest) UnmarshalJSON(b []byte) error

func (ApiCustomDeleteRequest) WithParameters 

func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCustomDeleteRequest

WithParameters adds the parameters to the ApiCustomDeleteRequest and returns the request for chaining.

type ApiCustomGetRequest 

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

ApiCustomGetRequest represents the request with all the parameters for the API call.

func (*ApiCustomGetRequest) UnmarshalJSON 

func (r *ApiCustomGetRequest) UnmarshalJSON(b []byte) error

func (ApiCustomGetRequest) WithParameters 

func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustomGetRequest

WithParameters adds the parameters to the ApiCustomGetRequest and returns the request for chaining.

type ApiCustomPostRequest 

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

ApiCustomPostRequest represents the request with all the parameters for the API call.

func (*ApiCustomPostRequest) UnmarshalJSON 

func (r *ApiCustomPostRequest) UnmarshalJSON(b []byte) error

func (ApiCustomPostRequest) WithBody 

func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest

WithBody adds the body to the ApiCustomPostRequest and returns the request for chaining.

func (ApiCustomPostRequest) WithParameters 

func (r ApiCustomPostRequest) WithParameters(parameters map[string]any) ApiCustomPostRequest

WithParameters adds the parameters to the ApiCustomPostRequest and returns the request for chaining.

type ApiCustomPutRequest 

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

ApiCustomPutRequest represents the request with all the parameters for the API call.

func (*ApiCustomPutRequest) UnmarshalJSON 

func (r *ApiCustomPutRequest) UnmarshalJSON(b []byte) error

func (ApiCustomPutRequest) WithBody 

func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest

WithBody adds the body to the ApiCustomPutRequest and returns the request for chaining.

func (ApiCustomPutRequest) WithParameters 

func (r ApiCustomPutRequest) WithParameters(parameters map[string]any) ApiCustomPutRequest

WithParameters adds the parameters to the ApiCustomPutRequest and returns the request for chaining.

type ApiGetAddToCartRateRequest 

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

ApiGetAddToCartRateRequest represents the request with all the parameters for the API call.

func (*ApiGetAddToCartRateRequest) UnmarshalJSON 

func (r *ApiGetAddToCartRateRequest) UnmarshalJSON(b []byte) error

func (ApiGetAddToCartRateRequest) WithEndDate 

func (r ApiGetAddToCartRateRequest) WithEndDate(endDate string) ApiGetAddToCartRateRequest

WithEndDate adds the endDate to the ApiGetAddToCartRateRequest and returns the request for chaining.

func (ApiGetAddToCartRateRequest) WithStartDate 

func (r ApiGetAddToCartRateRequest) WithStartDate(startDate string) ApiGetAddToCartRateRequest

WithStartDate adds the startDate to the ApiGetAddToCartRateRequest and returns the request for chaining.

func (ApiGetAddToCartRateRequest) WithTags 

func (r ApiGetAddToCartRateRequest) WithTags(tags string) ApiGetAddToCartRateRequest

WithTags adds the tags to the ApiGetAddToCartRateRequest and returns the request for chaining.

type ApiGetAverageClickPositionRequest 

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

ApiGetAverageClickPositionRequest represents the request with all the parameters for the API call.

func (*ApiGetAverageClickPositionRequest) UnmarshalJSON 

func (r *ApiGetAverageClickPositionRequest) UnmarshalJSON(b []byte) error

func (ApiGetAverageClickPositionRequest) WithEndDate 

func (r ApiGetAverageClickPositionRequest) WithEndDate(endDate string) ApiGetAverageClickPositionRequest

WithEndDate adds the endDate to the ApiGetAverageClickPositionRequest and returns the request for chaining.

func (ApiGetAverageClickPositionRequest) WithStartDate 

func (r ApiGetAverageClickPositionRequest) WithStartDate(startDate string) ApiGetAverageClickPositionRequest

WithStartDate adds the startDate to the ApiGetAverageClickPositionRequest and returns the request for chaining.

func (ApiGetAverageClickPositionRequest) WithTags 

func (r ApiGetAverageClickPositionRequest) WithTags(tags string) ApiGetAverageClickPositionRequest

WithTags adds the tags to the ApiGetAverageClickPositionRequest and returns the request for chaining.

type ApiGetClickPositionsRequest 

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

ApiGetClickPositionsRequest represents the request with all the parameters for the API call.

func (*ApiGetClickPositionsRequest) UnmarshalJSON 

func (r *ApiGetClickPositionsRequest) UnmarshalJSON(b []byte) error

func (ApiGetClickPositionsRequest) WithEndDate 

func (r ApiGetClickPositionsRequest) WithEndDate(endDate string) ApiGetClickPositionsRequest

WithEndDate adds the endDate to the ApiGetClickPositionsRequest and returns the request for chaining.

func (ApiGetClickPositionsRequest) WithStartDate 

func (r ApiGetClickPositionsRequest) WithStartDate(startDate string) ApiGetClickPositionsRequest

WithStartDate adds the startDate to the ApiGetClickPositionsRequest and returns the request for chaining.

func (ApiGetClickPositionsRequest) WithTags 

func (r ApiGetClickPositionsRequest) WithTags(tags string) ApiGetClickPositionsRequest

WithTags adds the tags to the ApiGetClickPositionsRequest and returns the request for chaining.

type ApiGetClickThroughRateRequest 

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

ApiGetClickThroughRateRequest represents the request with all the parameters for the API call.

func (*ApiGetClickThroughRateRequest) UnmarshalJSON 

func (r *ApiGetClickThroughRateRequest) UnmarshalJSON(b []byte) error

func (ApiGetClickThroughRateRequest) WithEndDate 

func (r ApiGetClickThroughRateRequest) WithEndDate(endDate string) ApiGetClickThroughRateRequest

WithEndDate adds the endDate to the ApiGetClickThroughRateRequest and returns the request for chaining.

func (ApiGetClickThroughRateRequest) WithStartDate 

func (r ApiGetClickThroughRateRequest) WithStartDate(startDate string) ApiGetClickThroughRateRequest

WithStartDate adds the startDate to the ApiGetClickThroughRateRequest and returns the request for chaining.

func (ApiGetClickThroughRateRequest) WithTags 

func (r ApiGetClickThroughRateRequest) WithTags(tags string) ApiGetClickThroughRateRequest

WithTags adds the tags to the ApiGetClickThroughRateRequest and returns the request for chaining.

type ApiGetConversionRateRequest 

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

ApiGetConversionRateRequest represents the request with all the parameters for the API call.

func (*ApiGetConversionRateRequest) UnmarshalJSON 

func (r *ApiGetConversionRateRequest) UnmarshalJSON(b []byte) error

func (ApiGetConversionRateRequest) WithEndDate 

func (r ApiGetConversionRateRequest) WithEndDate(endDate string) ApiGetConversionRateRequest

WithEndDate adds the endDate to the ApiGetConversionRateRequest and returns the request for chaining.

func (ApiGetConversionRateRequest) WithStartDate 

func (r ApiGetConversionRateRequest) WithStartDate(startDate string) ApiGetConversionRateRequest

WithStartDate adds the startDate to the ApiGetConversionRateRequest and returns the request for chaining.

func (ApiGetConversionRateRequest) WithTags 

func (r ApiGetConversionRateRequest) WithTags(tags string) ApiGetConversionRateRequest

WithTags adds the tags to the ApiGetConversionRateRequest and returns the request for chaining.

type ApiGetNoClickRateRequest 

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

ApiGetNoClickRateRequest represents the request with all the parameters for the API call.

func (*ApiGetNoClickRateRequest) UnmarshalJSON 

func (r *ApiGetNoClickRateRequest) UnmarshalJSON(b []byte) error

func (ApiGetNoClickRateRequest) WithEndDate 

func (r ApiGetNoClickRateRequest) WithEndDate(endDate string) ApiGetNoClickRateRequest

WithEndDate adds the endDate to the ApiGetNoClickRateRequest and returns the request for chaining.

func (ApiGetNoClickRateRequest) WithStartDate 

func (r ApiGetNoClickRateRequest) WithStartDate(startDate string) ApiGetNoClickRateRequest

WithStartDate adds the startDate to the ApiGetNoClickRateRequest and returns the request for chaining.

func (ApiGetNoClickRateRequest) WithTags 

func (r ApiGetNoClickRateRequest) WithTags(tags string) ApiGetNoClickRateRequest

WithTags adds the tags to the ApiGetNoClickRateRequest and returns the request for chaining.

type ApiGetNoResultsRateRequest 

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

ApiGetNoResultsRateRequest represents the request with all the parameters for the API call.

func (*ApiGetNoResultsRateRequest) UnmarshalJSON 

func (r *ApiGetNoResultsRateRequest) UnmarshalJSON(b []byte) error

func (ApiGetNoResultsRateRequest) WithEndDate 

func (r ApiGetNoResultsRateRequest) WithEndDate(endDate string) ApiGetNoResultsRateRequest

WithEndDate adds the endDate to the ApiGetNoResultsRateRequest and returns the request for chaining.

func (ApiGetNoResultsRateRequest) WithStartDate 

func (r ApiGetNoResultsRateRequest) WithStartDate(startDate string) ApiGetNoResultsRateRequest

WithStartDate adds the startDate to the ApiGetNoResultsRateRequest and returns the request for chaining.

func (ApiGetNoResultsRateRequest) WithTags 

func (r ApiGetNoResultsRateRequest) WithTags(tags string) ApiGetNoResultsRateRequest

WithTags adds the tags to the ApiGetNoResultsRateRequest and returns the request for chaining.

type ApiGetPurchaseRateRequest 

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

ApiGetPurchaseRateRequest represents the request with all the parameters for the API call.

func (*ApiGetPurchaseRateRequest) UnmarshalJSON 

func (r *ApiGetPurchaseRateRequest) UnmarshalJSON(b []byte) error

func (ApiGetPurchaseRateRequest) WithEndDate 

func (r ApiGetPurchaseRateRequest) WithEndDate(endDate string) ApiGetPurchaseRateRequest

WithEndDate adds the endDate to the ApiGetPurchaseRateRequest and returns the request for chaining.

func (ApiGetPurchaseRateRequest) WithStartDate 

func (r ApiGetPurchaseRateRequest) WithStartDate(startDate string) ApiGetPurchaseRateRequest

WithStartDate adds the startDate to the ApiGetPurchaseRateRequest and returns the request for chaining.

func (ApiGetPurchaseRateRequest) WithTags 

func (r ApiGetPurchaseRateRequest) WithTags(tags string) ApiGetPurchaseRateRequest

WithTags adds the tags to the ApiGetPurchaseRateRequest and returns the request for chaining.

type ApiGetRevenueRequest 

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

ApiGetRevenueRequest represents the request with all the parameters for the API call.

func (*ApiGetRevenueRequest) UnmarshalJSON 

func (r *ApiGetRevenueRequest) UnmarshalJSON(b []byte) error

func (ApiGetRevenueRequest) WithEndDate 

func (r ApiGetRevenueRequest) WithEndDate(endDate string) ApiGetRevenueRequest

WithEndDate adds the endDate to the ApiGetRevenueRequest and returns the request for chaining.

func (ApiGetRevenueRequest) WithStartDate 

func (r ApiGetRevenueRequest) WithStartDate(startDate string) ApiGetRevenueRequest

WithStartDate adds the startDate to the ApiGetRevenueRequest and returns the request for chaining.

func (ApiGetRevenueRequest) WithTags 

func (r ApiGetRevenueRequest) WithTags(tags string) ApiGetRevenueRequest

WithTags adds the tags to the ApiGetRevenueRequest and returns the request for chaining.

type ApiGetSearchesCountRequest 

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

ApiGetSearchesCountRequest represents the request with all the parameters for the API call.

func (*ApiGetSearchesCountRequest) UnmarshalJSON 

func (r *ApiGetSearchesCountRequest) UnmarshalJSON(b []byte) error

func (ApiGetSearchesCountRequest) WithEndDate 

func (r ApiGetSearchesCountRequest) WithEndDate(endDate string) ApiGetSearchesCountRequest

WithEndDate adds the endDate to the ApiGetSearchesCountRequest and returns the request for chaining.

func (ApiGetSearchesCountRequest) WithStartDate 

func (r ApiGetSearchesCountRequest) WithStartDate(startDate string) ApiGetSearchesCountRequest

WithStartDate adds the startDate to the ApiGetSearchesCountRequest and returns the request for chaining.

func (ApiGetSearchesCountRequest) WithTags 

func (r ApiGetSearchesCountRequest) WithTags(tags string) ApiGetSearchesCountRequest

WithTags adds the tags to the ApiGetSearchesCountRequest and returns the request for chaining.

type ApiGetSearchesNoClicksRequest 

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

ApiGetSearchesNoClicksRequest represents the request with all the parameters for the API call.

func (*ApiGetSearchesNoClicksRequest) UnmarshalJSON 

func (r *ApiGetSearchesNoClicksRequest) UnmarshalJSON(b []byte) error

func (ApiGetSearchesNoClicksRequest) WithEndDate 

func (r ApiGetSearchesNoClicksRequest) WithEndDate(endDate string) ApiGetSearchesNoClicksRequest

WithEndDate adds the endDate to the ApiGetSearchesNoClicksRequest and returns the request for chaining.

func (ApiGetSearchesNoClicksRequest) WithLimit 

func (r ApiGetSearchesNoClicksRequest) WithLimit(limit int32) ApiGetSearchesNoClicksRequest

WithLimit adds the limit to the ApiGetSearchesNoClicksRequest and returns the request for chaining.

func (ApiGetSearchesNoClicksRequest) WithOffset 

func (r ApiGetSearchesNoClicksRequest) WithOffset(offset int32) ApiGetSearchesNoClicksRequest

WithOffset adds the offset to the ApiGetSearchesNoClicksRequest and returns the request for chaining.

func (ApiGetSearchesNoClicksRequest) WithStartDate 

func (r ApiGetSearchesNoClicksRequest) WithStartDate(startDate string) ApiGetSearchesNoClicksRequest

WithStartDate adds the startDate to the ApiGetSearchesNoClicksRequest and returns the request for chaining.

func (ApiGetSearchesNoClicksRequest) WithTags 

func (r ApiGetSearchesNoClicksRequest) WithTags(tags string) ApiGetSearchesNoClicksRequest

WithTags adds the tags to the ApiGetSearchesNoClicksRequest and returns the request for chaining.

type ApiGetSearchesNoResultsRequest 

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

ApiGetSearchesNoResultsRequest represents the request with all the parameters for the API call.

func (*ApiGetSearchesNoResultsRequest) UnmarshalJSON 

func (r *ApiGetSearchesNoResultsRequest) UnmarshalJSON(b []byte) error

func (ApiGetSearchesNoResultsRequest) WithEndDate 

func (r ApiGetSearchesNoResultsRequest) WithEndDate(endDate string) ApiGetSearchesNoResultsRequest

WithEndDate adds the endDate to the ApiGetSearchesNoResultsRequest and returns the request for chaining.

func (ApiGetSearchesNoResultsRequest) WithLimit 

func (r ApiGetSearchesNoResultsRequest) WithLimit(limit int32) ApiGetSearchesNoResultsRequest

WithLimit adds the limit to the ApiGetSearchesNoResultsRequest and returns the request for chaining.

func (ApiGetSearchesNoResultsRequest) WithOffset 

func (r ApiGetSearchesNoResultsRequest) WithOffset(offset int32) ApiGetSearchesNoResultsRequest

WithOffset adds the offset to the ApiGetSearchesNoResultsRequest and returns the request for chaining.

func (ApiGetSearchesNoResultsRequest) WithStartDate 

func (r ApiGetSearchesNoResultsRequest) WithStartDate(startDate string) ApiGetSearchesNoResultsRequest

WithStartDate adds the startDate to the ApiGetSearchesNoResultsRequest and returns the request for chaining.

func (ApiGetSearchesNoResultsRequest) WithTags 

func (r ApiGetSearchesNoResultsRequest) WithTags(tags string) ApiGetSearchesNoResultsRequest

WithTags adds the tags to the ApiGetSearchesNoResultsRequest and returns the request for chaining.

type ApiGetStatusRequest 

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

ApiGetStatusRequest represents the request with all the parameters for the API call.

func (*ApiGetStatusRequest) UnmarshalJSON 

func (r *ApiGetStatusRequest) UnmarshalJSON(b []byte) error

type ApiGetTopCountriesRequest 

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

ApiGetTopCountriesRequest represents the request with all the parameters for the API call.

func (*ApiGetTopCountriesRequest) UnmarshalJSON 

func (r *ApiGetTopCountriesRequest) UnmarshalJSON(b []byte) error

func (ApiGetTopCountriesRequest) WithEndDate 

func (r ApiGetTopCountriesRequest) WithEndDate(endDate string) ApiGetTopCountriesRequest

WithEndDate adds the endDate to the ApiGetTopCountriesRequest and returns the request for chaining.

func (ApiGetTopCountriesRequest) WithLimit 

func (r ApiGetTopCountriesRequest) WithLimit(limit int32) ApiGetTopCountriesRequest

WithLimit adds the limit to the ApiGetTopCountriesRequest and returns the request for chaining.

func (ApiGetTopCountriesRequest) WithOffset 

func (r ApiGetTopCountriesRequest) WithOffset(offset int32) ApiGetTopCountriesRequest

WithOffset adds the offset to the ApiGetTopCountriesRequest and returns the request for chaining.

func (ApiGetTopCountriesRequest) WithStartDate 

func (r ApiGetTopCountriesRequest) WithStartDate(startDate string) ApiGetTopCountriesRequest

WithStartDate adds the startDate to the ApiGetTopCountriesRequest and returns the request for chaining.

func (ApiGetTopCountriesRequest) WithTags 

func (r ApiGetTopCountriesRequest) WithTags(tags string) ApiGetTopCountriesRequest

WithTags adds the tags to the ApiGetTopCountriesRequest and returns the request for chaining.

type ApiGetTopFilterAttributesRequest 

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

ApiGetTopFilterAttributesRequest represents the request with all the parameters for the API call.

func (*ApiGetTopFilterAttributesRequest) UnmarshalJSON 

func (r *ApiGetTopFilterAttributesRequest) UnmarshalJSON(b []byte) error

func (ApiGetTopFilterAttributesRequest) WithEndDate 

func (r ApiGetTopFilterAttributesRequest) WithEndDate(endDate string) ApiGetTopFilterAttributesRequest

WithEndDate adds the endDate to the ApiGetTopFilterAttributesRequest and returns the request for chaining.

func (ApiGetTopFilterAttributesRequest) WithLimit 

func (r ApiGetTopFilterAttributesRequest) WithLimit(limit int32) ApiGetTopFilterAttributesRequest

WithLimit adds the limit to the ApiGetTopFilterAttributesRequest and returns the request for chaining.

func (ApiGetTopFilterAttributesRequest) WithOffset 

func (r ApiGetTopFilterAttributesRequest) WithOffset(offset int32) ApiGetTopFilterAttributesRequest

WithOffset adds the offset to the ApiGetTopFilterAttributesRequest and returns the request for chaining.

func (ApiGetTopFilterAttributesRequest) WithSearch 

func (r ApiGetTopFilterAttributesRequest) WithSearch(search string) ApiGetTopFilterAttributesRequest

WithSearch adds the search to the ApiGetTopFilterAttributesRequest and returns the request for chaining.

func (ApiGetTopFilterAttributesRequest) WithStartDate 

func (r ApiGetTopFilterAttributesRequest) WithStartDate(startDate string) ApiGetTopFilterAttributesRequest

WithStartDate adds the startDate to the ApiGetTopFilterAttributesRequest and returns the request for chaining.

func (ApiGetTopFilterAttributesRequest) WithTags 

func (r ApiGetTopFilterAttributesRequest) WithTags(tags string) ApiGetTopFilterAttributesRequest

WithTags adds the tags to the ApiGetTopFilterAttributesRequest and returns the request for chaining.

type ApiGetTopFilterForAttributeRequest 

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

ApiGetTopFilterForAttributeRequest represents the request with all the parameters for the API call.

func (*ApiGetTopFilterForAttributeRequest) UnmarshalJSON 

func (r *ApiGetTopFilterForAttributeRequest) UnmarshalJSON(b []byte) error

func (ApiGetTopFilterForAttributeRequest) WithEndDate 

func (r ApiGetTopFilterForAttributeRequest) WithEndDate(endDate string) ApiGetTopFilterForAttributeRequest

WithEndDate adds the endDate to the ApiGetTopFilterForAttributeRequest and returns the request for chaining.

func (ApiGetTopFilterForAttributeRequest) WithLimit 

func (r ApiGetTopFilterForAttributeRequest) WithLimit(limit int32) ApiGetTopFilterForAttributeRequest

WithLimit adds the limit to the ApiGetTopFilterForAttributeRequest and returns the request for chaining.

func (ApiGetTopFilterForAttributeRequest) WithOffset 

func (r ApiGetTopFilterForAttributeRequest) WithOffset(offset int32) ApiGetTopFilterForAttributeRequest

WithOffset adds the offset to the ApiGetTopFilterForAttributeRequest and returns the request for chaining.

func (ApiGetTopFilterForAttributeRequest) WithSearch 

func (r ApiGetTopFilterForAttributeRequest) WithSearch(search string) ApiGetTopFilterForAttributeRequest

WithSearch adds the search to the ApiGetTopFilterForAttributeRequest and returns the request for chaining.

func (ApiGetTopFilterForAttributeRequest) WithStartDate 

func (r ApiGetTopFilterForAttributeRequest) WithStartDate(startDate string) ApiGetTopFilterForAttributeRequest

WithStartDate adds the startDate to the ApiGetTopFilterForAttributeRequest and returns the request for chaining.

func (ApiGetTopFilterForAttributeRequest) WithTags 

func (r ApiGetTopFilterForAttributeRequest) WithTags(tags string) ApiGetTopFilterForAttributeRequest

WithTags adds the tags to the ApiGetTopFilterForAttributeRequest and returns the request for chaining.

type ApiGetTopFiltersNoResultsRequest 

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

ApiGetTopFiltersNoResultsRequest represents the request with all the parameters for the API call.

func (*ApiGetTopFiltersNoResultsRequest) UnmarshalJSON 

func (r *ApiGetTopFiltersNoResultsRequest) UnmarshalJSON(b []byte) error

func (ApiGetTopFiltersNoResultsRequest) WithEndDate 

func (r ApiGetTopFiltersNoResultsRequest) WithEndDate(endDate string) ApiGetTopFiltersNoResultsRequest

WithEndDate adds the endDate to the ApiGetTopFiltersNoResultsRequest and returns the request for chaining.

func (ApiGetTopFiltersNoResultsRequest) WithLimit 

func (r ApiGetTopFiltersNoResultsRequest) WithLimit(limit int32) ApiGetTopFiltersNoResultsRequest

WithLimit adds the limit to the ApiGetTopFiltersNoResultsRequest and returns the request for chaining.

func (ApiGetTopFiltersNoResultsRequest) WithOffset 

func (r ApiGetTopFiltersNoResultsRequest) WithOffset(offset int32) ApiGetTopFiltersNoResultsRequest

WithOffset adds the offset to the ApiGetTopFiltersNoResultsRequest and returns the request for chaining.

func (ApiGetTopFiltersNoResultsRequest) WithSearch 

func (r ApiGetTopFiltersNoResultsRequest) WithSearch(search string) ApiGetTopFiltersNoResultsRequest

WithSearch adds the search to the ApiGetTopFiltersNoResultsRequest and returns the request for chaining.

func (ApiGetTopFiltersNoResultsRequest) WithStartDate 

func (r ApiGetTopFiltersNoResultsRequest) WithStartDate(startDate string) ApiGetTopFiltersNoResultsRequest

WithStartDate adds the startDate to the ApiGetTopFiltersNoResultsRequest and returns the request for chaining.

func (ApiGetTopFiltersNoResultsRequest) WithTags 

func (r ApiGetTopFiltersNoResultsRequest) WithTags(tags string) ApiGetTopFiltersNoResultsRequest

WithTags adds the tags to the ApiGetTopFiltersNoResultsRequest and returns the request for chaining.

type ApiGetTopHitsRequest 

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

ApiGetTopHitsRequest represents the request with all the parameters for the API call.

func (*ApiGetTopHitsRequest) UnmarshalJSON 

func (r *ApiGetTopHitsRequest) UnmarshalJSON(b []byte) error

func (ApiGetTopHitsRequest) WithClickAnalytics 

func (r ApiGetTopHitsRequest) WithClickAnalytics(clickAnalytics bool) ApiGetTopHitsRequest

WithClickAnalytics adds the clickAnalytics to the ApiGetTopHitsRequest and returns the request for chaining.

func (ApiGetTopHitsRequest) WithEndDate 

func (r ApiGetTopHitsRequest) WithEndDate(endDate string) ApiGetTopHitsRequest

WithEndDate adds the endDate to the ApiGetTopHitsRequest and returns the request for chaining.

func (ApiGetTopHitsRequest) WithLimit 

func (r ApiGetTopHitsRequest) WithLimit(limit int32) ApiGetTopHitsRequest

WithLimit adds the limit to the ApiGetTopHitsRequest and returns the request for chaining.

func (ApiGetTopHitsRequest) WithOffset 

func (r ApiGetTopHitsRequest) WithOffset(offset int32) ApiGetTopHitsRequest

WithOffset adds the offset to the ApiGetTopHitsRequest and returns the request for chaining.

func (ApiGetTopHitsRequest) WithRevenueAnalytics 

func (r ApiGetTopHitsRequest) WithRevenueAnalytics(revenueAnalytics bool) ApiGetTopHitsRequest

WithRevenueAnalytics adds the revenueAnalytics to the ApiGetTopHitsRequest and returns the request for chaining.

func (ApiGetTopHitsRequest) WithSearch 

func (r ApiGetTopHitsRequest) WithSearch(search string) ApiGetTopHitsRequest

WithSearch adds the search to the ApiGetTopHitsRequest and returns the request for chaining.

func (ApiGetTopHitsRequest) WithStartDate 

func (r ApiGetTopHitsRequest) WithStartDate(startDate string) ApiGetTopHitsRequest

WithStartDate adds the startDate to the ApiGetTopHitsRequest and returns the request for chaining.

func (ApiGetTopHitsRequest) WithTags 

func (r ApiGetTopHitsRequest) WithTags(tags string) ApiGetTopHitsRequest

WithTags adds the tags to the ApiGetTopHitsRequest and returns the request for chaining.

type ApiGetTopSearchesRequest 

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

ApiGetTopSearchesRequest represents the request with all the parameters for the API call.

func (*ApiGetTopSearchesRequest) UnmarshalJSON 

func (r *ApiGetTopSearchesRequest) UnmarshalJSON(b []byte) error

func (ApiGetTopSearchesRequest) WithClickAnalytics 

func (r ApiGetTopSearchesRequest) WithClickAnalytics(clickAnalytics bool) ApiGetTopSearchesRequest

WithClickAnalytics adds the clickAnalytics to the ApiGetTopSearchesRequest and returns the request for chaining.

func (ApiGetTopSearchesRequest) WithDirection 

func (r ApiGetTopSearchesRequest) WithDirection(direction Direction) ApiGetTopSearchesRequest

WithDirection adds the direction to the ApiGetTopSearchesRequest and returns the request for chaining.

func (ApiGetTopSearchesRequest) WithEndDate 

func (r ApiGetTopSearchesRequest) WithEndDate(endDate string) ApiGetTopSearchesRequest

WithEndDate adds the endDate to the ApiGetTopSearchesRequest and returns the request for chaining.

func (ApiGetTopSearchesRequest) WithLimit 

func (r ApiGetTopSearchesRequest) WithLimit(limit int32) ApiGetTopSearchesRequest

WithLimit adds the limit to the ApiGetTopSearchesRequest and returns the request for chaining.

func (ApiGetTopSearchesRequest) WithOffset 

func (r ApiGetTopSearchesRequest) WithOffset(offset int32) ApiGetTopSearchesRequest

WithOffset adds the offset to the ApiGetTopSearchesRequest and returns the request for chaining.

func (ApiGetTopSearchesRequest) WithOrderBy 

func (r ApiGetTopSearchesRequest) WithOrderBy(orderBy OrderBy) ApiGetTopSearchesRequest

WithOrderBy adds the orderBy to the ApiGetTopSearchesRequest and returns the request for chaining.

func (ApiGetTopSearchesRequest) WithRevenueAnalytics 

func (r ApiGetTopSearchesRequest) WithRevenueAnalytics(revenueAnalytics bool) ApiGetTopSearchesRequest

WithRevenueAnalytics adds the revenueAnalytics to the ApiGetTopSearchesRequest and returns the request for chaining.

func (ApiGetTopSearchesRequest) WithStartDate 

func (r ApiGetTopSearchesRequest) WithStartDate(startDate string) ApiGetTopSearchesRequest

WithStartDate adds the startDate to the ApiGetTopSearchesRequest and returns the request for chaining.

func (ApiGetTopSearchesRequest) WithTags 

func (r ApiGetTopSearchesRequest) WithTags(tags string) ApiGetTopSearchesRequest

WithTags adds the tags to the ApiGetTopSearchesRequest and returns the request for chaining.

type ApiGetUsersCountRequest 

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

ApiGetUsersCountRequest represents the request with all the parameters for the API call.

func (*ApiGetUsersCountRequest) UnmarshalJSON 

func (r *ApiGetUsersCountRequest) UnmarshalJSON(b []byte) error

func (ApiGetUsersCountRequest) WithEndDate 

func (r ApiGetUsersCountRequest) WithEndDate(endDate string) ApiGetUsersCountRequest

WithEndDate adds the endDate to the ApiGetUsersCountRequest and returns the request for chaining.

func (ApiGetUsersCountRequest) WithStartDate 

func (r ApiGetUsersCountRequest) WithStartDate(startDate string) ApiGetUsersCountRequest

WithStartDate adds the startDate to the ApiGetUsersCountRequest and returns the request for chaining.

func (ApiGetUsersCountRequest) WithTags 

func (r ApiGetUsersCountRequest) WithTags(tags string) ApiGetUsersCountRequest

WithTags adds the tags to the ApiGetUsersCountRequest and returns the request for chaining.

type ClickPosition 

type ClickPosition struct {
	// Range of positions in the search results, using the pattern `[start,end]`.  For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
	Position []int32 `json:"position,omitempty"`
	// Number of times this search has been clicked at that position.
	ClickCount *int32 `json:"clickCount,omitempty"`
}

ClickPosition Click position.

func NewClickPosition 

func NewClickPosition(opts ...ClickPositionOption) *ClickPosition

NewClickPosition instantiates a new ClickPosition object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyClickPosition 

func NewEmptyClickPosition() *ClickPosition

NewEmptyClickPosition return a pointer to an empty ClickPosition object.

func (*ClickPosition) GetClickCount 

func (o *ClickPosition) GetClickCount() int32

GetClickCount returns the ClickCount field value if set, zero value otherwise.

func (*ClickPosition) GetClickCountOk 

func (o *ClickPosition) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ClickPosition) GetPosition 

func (o *ClickPosition) GetPosition() []int32

GetPosition returns the Position field value if set, zero value otherwise.

func (*ClickPosition) GetPositionOk 

func (o *ClickPosition) GetPositionOk() ([]int32, bool)

GetPositionOk returns a tuple with the Position field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ClickPosition) HasClickCount 

func (o *ClickPosition) HasClickCount() bool

HasClickCount returns a boolean if a field has been set.

func (*ClickPosition) HasPosition 

func (o *ClickPosition) HasPosition() bool

HasPosition returns a boolean if a field has been set.

func (ClickPosition) MarshalJSON 

func (o ClickPosition) MarshalJSON() ([]byte, error)

func (*ClickPosition) SetClickCount 

func (o *ClickPosition) SetClickCount(v int32) *ClickPosition

SetClickCount gets a reference to the given int32 and assigns it to the ClickCount field.

func (*ClickPosition) SetPosition 

func (o *ClickPosition) SetPosition(v []int32) *ClickPosition

SetPosition gets a reference to the given []int32 and assigns it to the Position field.

func (ClickPosition) String 

func (o ClickPosition) String() string

type ClickPositionOption 

type ClickPositionOption func(f *ClickPosition)

func WithClickPositionClickCount 

func WithClickPositionClickCount(val int32) ClickPositionOption

func WithClickPositionPosition 

func WithClickPositionPosition(val []int32) ClickPositionOption

type CurrencyCode added in v4.2.0 

type CurrencyCode struct {
	// Currency code.
	Currency *string `json:"currency,omitempty"`
	// Revenue associated with this search in this currency.
	Revenue *float32 `json:"revenue,omitempty"`
}

CurrencyCode Currency code.

func NewCurrencyCode added in v4.2.0 

func NewCurrencyCode(opts ...CurrencyCodeOption) *CurrencyCode

NewCurrencyCode instantiates a new CurrencyCode object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCurrencyCode added in v4.2.0 

func NewEmptyCurrencyCode() *CurrencyCode

NewEmptyCurrencyCode return a pointer to an empty CurrencyCode object.

func (*CurrencyCode) GetCurrency added in v4.2.0 

func (o *CurrencyCode) GetCurrency() string

GetCurrency returns the Currency field value if set, zero value otherwise.

func (*CurrencyCode) GetCurrencyOk added in v4.2.0 

func (o *CurrencyCode) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CurrencyCode) GetRevenue added in v4.2.0 

func (o *CurrencyCode) GetRevenue() float32

GetRevenue returns the Revenue field value if set, zero value otherwise.

func (*CurrencyCode) GetRevenueOk added in v4.2.0 

func (o *CurrencyCode) GetRevenueOk() (*float32, bool)

GetRevenueOk returns a tuple with the Revenue field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CurrencyCode) HasCurrency added in v4.2.0 

func (o *CurrencyCode) HasCurrency() bool

HasCurrency returns a boolean if a field has been set.

func (*CurrencyCode) HasRevenue added in v4.2.0 

func (o *CurrencyCode) HasRevenue() bool

HasRevenue returns a boolean if a field has been set.

func (CurrencyCode) MarshalJSON added in v4.2.0 

func (o CurrencyCode) MarshalJSON() ([]byte, error)

func (*CurrencyCode) SetCurrency added in v4.2.0 

func (o *CurrencyCode) SetCurrency(v string) *CurrencyCode

SetCurrency gets a reference to the given string and assigns it to the Currency field.

func (*CurrencyCode) SetRevenue added in v4.2.0 

func (o *CurrencyCode) SetRevenue(v float32) *CurrencyCode

SetRevenue gets a reference to the given float32 and assigns it to the Revenue field.

func (CurrencyCode) String added in v4.2.0 

func (o CurrencyCode) String() string

type CurrencyCodeOption added in v4.2.0 

type CurrencyCodeOption func(f *CurrencyCode)

func WithCurrencyCodeCurrency added in v4.2.0 

func WithCurrencyCodeCurrency(val string) CurrencyCodeOption

func WithCurrencyCodeRevenue added in v4.2.0 

func WithCurrencyCodeRevenue(val float32) CurrencyCodeOption

type DailyAddToCartRates 

type DailyAddToCartRates struct {
	// Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Rate utils.Nullable[float64] `json:"rate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Number of add-to-cart events from this search.
	AddToCartCount int32 `json:"addToCartCount"`
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
}

DailyAddToCartRates struct for DailyAddToCartRates.

func NewDailyAddToCartRates 

func NewDailyAddToCartRates(rate utils.Nullable[float64], trackedSearchCount int32, addToCartCount int32, date string) *DailyAddToCartRates

NewDailyAddToCartRates instantiates a new DailyAddToCartRates object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyAddToCartRates 

func NewEmptyDailyAddToCartRates() *DailyAddToCartRates

NewEmptyDailyAddToCartRates return a pointer to an empty DailyAddToCartRates object.

func (*DailyAddToCartRates) GetAddToCartCount 

func (o *DailyAddToCartRates) GetAddToCartCount() int32

GetAddToCartCount returns the AddToCartCount field value.

func (*DailyAddToCartRates) GetAddToCartCountOk 

func (o *DailyAddToCartRates) GetAddToCartCountOk() (*int32, bool)

GetAddToCartCountOk returns a tuple with the AddToCartCount field value and a boolean to check if the value has been set.

func (*DailyAddToCartRates) GetDate 

func (o *DailyAddToCartRates) GetDate() string

GetDate returns the Date field value.

func (*DailyAddToCartRates) GetDateOk 

func (o *DailyAddToCartRates) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (*DailyAddToCartRates) GetRate 

func (o *DailyAddToCartRates) GetRate() float64

GetRate returns the Rate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*DailyAddToCartRates) GetRateOk 

func (o *DailyAddToCartRates) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*DailyAddToCartRates) GetTrackedSearchCount 

func (o *DailyAddToCartRates) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*DailyAddToCartRates) GetTrackedSearchCountOk 

func (o *DailyAddToCartRates) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (DailyAddToCartRates) MarshalJSON 

func (o DailyAddToCartRates) MarshalJSON() ([]byte, error)

func (*DailyAddToCartRates) SetAddToCartCount 

func (o *DailyAddToCartRates) SetAddToCartCount(v int32) *DailyAddToCartRates

SetAddToCartCount sets field value.

func (*DailyAddToCartRates) SetDate 

func (o *DailyAddToCartRates) SetDate(v string) *DailyAddToCartRates

SetDate sets field value.

func (*DailyAddToCartRates) SetRate 

func (o *DailyAddToCartRates) SetRate(v float64) *DailyAddToCartRates

SetRate sets field value.

func (*DailyAddToCartRates) SetTrackedSearchCount 

func (o *DailyAddToCartRates) SetTrackedSearchCount(v int32) *DailyAddToCartRates

SetTrackedSearchCount sets field value.

func (DailyAddToCartRates) String 

func (o DailyAddToCartRates) String() string

type DailyAverageClicks 

type DailyAverageClicks struct {
	// Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Average utils.Nullable[float64] `json:"average"`
	// Number of clicks associated with this search.
	ClickCount int32 `json:"clickCount"`
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
}

DailyAverageClicks struct for DailyAverageClicks.

func NewDailyAverageClicks 

func NewDailyAverageClicks(average utils.Nullable[float64], clickCount int32, date string) *DailyAverageClicks

NewDailyAverageClicks instantiates a new DailyAverageClicks object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyAverageClicks 

func NewEmptyDailyAverageClicks() *DailyAverageClicks

NewEmptyDailyAverageClicks return a pointer to an empty DailyAverageClicks object.

func (*DailyAverageClicks) GetAverage 

func (o *DailyAverageClicks) GetAverage() float64

GetAverage returns the Average field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*DailyAverageClicks) GetAverageOk 

func (o *DailyAverageClicks) GetAverageOk() (*float64, bool)

GetAverageOk returns a tuple with the Average field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*DailyAverageClicks) GetClickCount 

func (o *DailyAverageClicks) GetClickCount() int32

GetClickCount returns the ClickCount field value.

func (*DailyAverageClicks) GetClickCountOk 

func (o *DailyAverageClicks) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value and a boolean to check if the value has been set.

func (*DailyAverageClicks) GetDate 

func (o *DailyAverageClicks) GetDate() string

GetDate returns the Date field value.

func (*DailyAverageClicks) GetDateOk 

func (o *DailyAverageClicks) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (DailyAverageClicks) MarshalJSON 

func (o DailyAverageClicks) MarshalJSON() ([]byte, error)

func (*DailyAverageClicks) SetAverage 

func (o *DailyAverageClicks) SetAverage(v float64) *DailyAverageClicks

SetAverage sets field value.

func (*DailyAverageClicks) SetClickCount 

func (o *DailyAverageClicks) SetClickCount(v int32) *DailyAverageClicks

SetClickCount sets field value.

func (*DailyAverageClicks) SetDate 

func (o *DailyAverageClicks) SetDate(v string) *DailyAverageClicks

SetDate sets field value.

func (DailyAverageClicks) String 

func (o DailyAverageClicks) String() string

type DailyClickThroughRates 

type DailyClickThroughRates struct {
	// Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Rate utils.Nullable[float64] `json:"rate"`
	// Number of clicks associated with this search.
	ClickCount int32 `json:"clickCount"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
}

DailyClickThroughRates struct for DailyClickThroughRates.

func NewDailyClickThroughRates 

func NewDailyClickThroughRates(rate utils.Nullable[float64], clickCount int32, trackedSearchCount int32, date string) *DailyClickThroughRates

NewDailyClickThroughRates instantiates a new DailyClickThroughRates object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyClickThroughRates 

func NewEmptyDailyClickThroughRates() *DailyClickThroughRates

NewEmptyDailyClickThroughRates return a pointer to an empty DailyClickThroughRates object.

func (*DailyClickThroughRates) GetClickCount 

func (o *DailyClickThroughRates) GetClickCount() int32

GetClickCount returns the ClickCount field value.

func (*DailyClickThroughRates) GetClickCountOk 

func (o *DailyClickThroughRates) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value and a boolean to check if the value has been set.

func (*DailyClickThroughRates) GetDate 

func (o *DailyClickThroughRates) GetDate() string

GetDate returns the Date field value.

func (*DailyClickThroughRates) GetDateOk 

func (o *DailyClickThroughRates) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (*DailyClickThroughRates) GetRate 

func (o *DailyClickThroughRates) GetRate() float64

GetRate returns the Rate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*DailyClickThroughRates) GetRateOk 

func (o *DailyClickThroughRates) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*DailyClickThroughRates) GetTrackedSearchCount 

func (o *DailyClickThroughRates) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*DailyClickThroughRates) GetTrackedSearchCountOk 

func (o *DailyClickThroughRates) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (DailyClickThroughRates) MarshalJSON 

func (o DailyClickThroughRates) MarshalJSON() ([]byte, error)

func (*DailyClickThroughRates) SetClickCount 

func (o *DailyClickThroughRates) SetClickCount(v int32) *DailyClickThroughRates

SetClickCount sets field value.

func (*DailyClickThroughRates) SetDate 

func (o *DailyClickThroughRates) SetDate(v string) *DailyClickThroughRates

SetDate sets field value.

func (*DailyClickThroughRates) SetRate 

func (o *DailyClickThroughRates) SetRate(v float64) *DailyClickThroughRates

SetRate sets field value.

func (*DailyClickThroughRates) SetTrackedSearchCount 

func (o *DailyClickThroughRates) SetTrackedSearchCount(v int32) *DailyClickThroughRates

SetTrackedSearchCount sets field value.

func (DailyClickThroughRates) String 

func (o DailyClickThroughRates) String() string

type DailyConversionRates 

type DailyConversionRates struct {
	// Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Rate utils.Nullable[float64] `json:"rate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Number of conversions from this search.
	ConversionCount int32 `json:"conversionCount"`
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
}

DailyConversionRates struct for DailyConversionRates.

func NewDailyConversionRates 

func NewDailyConversionRates(rate utils.Nullable[float64], trackedSearchCount int32, conversionCount int32, date string) *DailyConversionRates

NewDailyConversionRates instantiates a new DailyConversionRates object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyConversionRates 

func NewEmptyDailyConversionRates() *DailyConversionRates

NewEmptyDailyConversionRates return a pointer to an empty DailyConversionRates object.

func (*DailyConversionRates) GetConversionCount 

func (o *DailyConversionRates) GetConversionCount() int32

GetConversionCount returns the ConversionCount field value.

func (*DailyConversionRates) GetConversionCountOk 

func (o *DailyConversionRates) GetConversionCountOk() (*int32, bool)

GetConversionCountOk returns a tuple with the ConversionCount field value and a boolean to check if the value has been set.

func (*DailyConversionRates) GetDate 

func (o *DailyConversionRates) GetDate() string

GetDate returns the Date field value.

func (*DailyConversionRates) GetDateOk 

func (o *DailyConversionRates) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (*DailyConversionRates) GetRate 

func (o *DailyConversionRates) GetRate() float64

GetRate returns the Rate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*DailyConversionRates) GetRateOk 

func (o *DailyConversionRates) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*DailyConversionRates) GetTrackedSearchCount 

func (o *DailyConversionRates) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*DailyConversionRates) GetTrackedSearchCountOk 

func (o *DailyConversionRates) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (DailyConversionRates) MarshalJSON 

func (o DailyConversionRates) MarshalJSON() ([]byte, error)

func (*DailyConversionRates) SetConversionCount 

func (o *DailyConversionRates) SetConversionCount(v int32) *DailyConversionRates

SetConversionCount sets field value.

func (*DailyConversionRates) SetDate 

func (o *DailyConversionRates) SetDate(v string) *DailyConversionRates

SetDate sets field value.

func (*DailyConversionRates) SetRate 

func (o *DailyConversionRates) SetRate(v float64) *DailyConversionRates

SetRate sets field value.

func (*DailyConversionRates) SetTrackedSearchCount 

func (o *DailyConversionRates) SetTrackedSearchCount(v int32) *DailyConversionRates

SetTrackedSearchCount sets field value.

func (DailyConversionRates) String 

func (o DailyConversionRates) String() string

type DailyNoClickRates 

type DailyNoClickRates struct {
	// No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
	Rate float64 `json:"rate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	Count int32 `json:"count"`
	// Number of times this search was returned as a result without any click.
	NoClickCount int32 `json:"noClickCount"`
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
}

DailyNoClickRates struct for DailyNoClickRates.

func NewDailyNoClickRates 

func NewDailyNoClickRates(rate float64, count int32, noClickCount int32, date string) *DailyNoClickRates

NewDailyNoClickRates instantiates a new DailyNoClickRates object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyNoClickRates 

func NewEmptyDailyNoClickRates() *DailyNoClickRates

NewEmptyDailyNoClickRates return a pointer to an empty DailyNoClickRates object.

func (*DailyNoClickRates) GetCount 

func (o *DailyNoClickRates) GetCount() int32

GetCount returns the Count field value.

func (*DailyNoClickRates) GetCountOk 

func (o *DailyNoClickRates) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*DailyNoClickRates) GetDate 

func (o *DailyNoClickRates) GetDate() string

GetDate returns the Date field value.

func (*DailyNoClickRates) GetDateOk 

func (o *DailyNoClickRates) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (*DailyNoClickRates) GetNoClickCount 

func (o *DailyNoClickRates) GetNoClickCount() int32

GetNoClickCount returns the NoClickCount field value.

func (*DailyNoClickRates) GetNoClickCountOk 

func (o *DailyNoClickRates) GetNoClickCountOk() (*int32, bool)

GetNoClickCountOk returns a tuple with the NoClickCount field value and a boolean to check if the value has been set.

func (*DailyNoClickRates) GetRate 

func (o *DailyNoClickRates) GetRate() float64

GetRate returns the Rate field value.

func (*DailyNoClickRates) GetRateOk 

func (o *DailyNoClickRates) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set.

func (DailyNoClickRates) MarshalJSON 

func (o DailyNoClickRates) MarshalJSON() ([]byte, error)

func (*DailyNoClickRates) SetCount 

func (o *DailyNoClickRates) SetCount(v int32) *DailyNoClickRates

SetCount sets field value.

func (*DailyNoClickRates) SetDate 

func (o *DailyNoClickRates) SetDate(v string) *DailyNoClickRates

SetDate sets field value.

func (*DailyNoClickRates) SetNoClickCount 

func (o *DailyNoClickRates) SetNoClickCount(v int32) *DailyNoClickRates

SetNoClickCount sets field value.

func (*DailyNoClickRates) SetRate 

func (o *DailyNoClickRates) SetRate(v float64) *DailyNoClickRates

SetRate sets field value.

func (DailyNoClickRates) String 

func (o DailyNoClickRates) String() string

type DailyNoResultsRates 

type DailyNoResultsRates struct {
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
	// Number of searches without any results.
	NoResultCount int32 `json:"noResultCount"`
	// Number of searches.
	Count int32 `json:"count"`
	// No results rate, calculated as number of searches with zero results divided by the total number of searches.
	Rate float64 `json:"rate"`
}

DailyNoResultsRates struct for DailyNoResultsRates.

func NewDailyNoResultsRates 

func NewDailyNoResultsRates(date string, noResultCount int32, count int32, rate float64) *DailyNoResultsRates

NewDailyNoResultsRates instantiates a new DailyNoResultsRates object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyNoResultsRates 

func NewEmptyDailyNoResultsRates() *DailyNoResultsRates

NewEmptyDailyNoResultsRates return a pointer to an empty DailyNoResultsRates object.

func (*DailyNoResultsRates) GetCount 

func (o *DailyNoResultsRates) GetCount() int32

GetCount returns the Count field value.

func (*DailyNoResultsRates) GetCountOk 

func (o *DailyNoResultsRates) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*DailyNoResultsRates) GetDate 

func (o *DailyNoResultsRates) GetDate() string

GetDate returns the Date field value.

func (*DailyNoResultsRates) GetDateOk 

func (o *DailyNoResultsRates) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (*DailyNoResultsRates) GetNoResultCount 

func (o *DailyNoResultsRates) GetNoResultCount() int32

GetNoResultCount returns the NoResultCount field value.

func (*DailyNoResultsRates) GetNoResultCountOk 

func (o *DailyNoResultsRates) GetNoResultCountOk() (*int32, bool)

GetNoResultCountOk returns a tuple with the NoResultCount field value and a boolean to check if the value has been set.

func (*DailyNoResultsRates) GetRate 

func (o *DailyNoResultsRates) GetRate() float64

GetRate returns the Rate field value.

func (*DailyNoResultsRates) GetRateOk 

func (o *DailyNoResultsRates) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set.

func (DailyNoResultsRates) MarshalJSON 

func (o DailyNoResultsRates) MarshalJSON() ([]byte, error)

func (*DailyNoResultsRates) SetCount 

func (o *DailyNoResultsRates) SetCount(v int32) *DailyNoResultsRates

SetCount sets field value.

func (*DailyNoResultsRates) SetDate 

func (o *DailyNoResultsRates) SetDate(v string) *DailyNoResultsRates

SetDate sets field value.

func (*DailyNoResultsRates) SetNoResultCount 

func (o *DailyNoResultsRates) SetNoResultCount(v int32) *DailyNoResultsRates

SetNoResultCount sets field value.

func (*DailyNoResultsRates) SetRate 

func (o *DailyNoResultsRates) SetRate(v float64) *DailyNoResultsRates

SetRate sets field value.

func (DailyNoResultsRates) String 

func (o DailyNoResultsRates) String() string

type DailyPurchaseRates 

type DailyPurchaseRates struct {
	// Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Rate utils.Nullable[float64] `json:"rate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Number of purchase events from this search.
	PurchaseCount int32 `json:"purchaseCount"`
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
}

DailyPurchaseRates struct for DailyPurchaseRates.

func NewDailyPurchaseRates 

func NewDailyPurchaseRates(rate utils.Nullable[float64], trackedSearchCount int32, purchaseCount int32, date string) *DailyPurchaseRates

NewDailyPurchaseRates instantiates a new DailyPurchaseRates object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyPurchaseRates 

func NewEmptyDailyPurchaseRates() *DailyPurchaseRates

NewEmptyDailyPurchaseRates return a pointer to an empty DailyPurchaseRates object.

func (*DailyPurchaseRates) GetDate 

func (o *DailyPurchaseRates) GetDate() string

GetDate returns the Date field value.

func (*DailyPurchaseRates) GetDateOk 

func (o *DailyPurchaseRates) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (*DailyPurchaseRates) GetPurchaseCount 

func (o *DailyPurchaseRates) GetPurchaseCount() int32

GetPurchaseCount returns the PurchaseCount field value.

func (*DailyPurchaseRates) GetPurchaseCountOk 

func (o *DailyPurchaseRates) GetPurchaseCountOk() (*int32, bool)

GetPurchaseCountOk returns a tuple with the PurchaseCount field value and a boolean to check if the value has been set.

func (*DailyPurchaseRates) GetRate 

func (o *DailyPurchaseRates) GetRate() float64

GetRate returns the Rate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*DailyPurchaseRates) GetRateOk 

func (o *DailyPurchaseRates) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*DailyPurchaseRates) GetTrackedSearchCount 

func (o *DailyPurchaseRates) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*DailyPurchaseRates) GetTrackedSearchCountOk 

func (o *DailyPurchaseRates) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (DailyPurchaseRates) MarshalJSON 

func (o DailyPurchaseRates) MarshalJSON() ([]byte, error)

func (*DailyPurchaseRates) SetDate 

func (o *DailyPurchaseRates) SetDate(v string) *DailyPurchaseRates

SetDate sets field value.

func (*DailyPurchaseRates) SetPurchaseCount 

func (o *DailyPurchaseRates) SetPurchaseCount(v int32) *DailyPurchaseRates

SetPurchaseCount sets field value.

func (*DailyPurchaseRates) SetRate 

func (o *DailyPurchaseRates) SetRate(v float64) *DailyPurchaseRates

SetRate sets field value.

func (*DailyPurchaseRates) SetTrackedSearchCount 

func (o *DailyPurchaseRates) SetTrackedSearchCount(v int32) *DailyPurchaseRates

SetTrackedSearchCount sets field value.

func (DailyPurchaseRates) String 

func (o DailyPurchaseRates) String() string

type DailyRevenue 

type DailyRevenue struct {
	// Revenue associated with this search, broken-down by currencies.
	Currencies map[string]CurrencyCode `json:"currencies"`
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
}

DailyRevenue struct for DailyRevenue.

func NewDailyRevenue 

func NewDailyRevenue(currencies map[string]CurrencyCode, date string) *DailyRevenue

NewDailyRevenue instantiates a new DailyRevenue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyRevenue 

func NewEmptyDailyRevenue() *DailyRevenue

NewEmptyDailyRevenue return a pointer to an empty DailyRevenue object.

func (*DailyRevenue) GetCurrencies 

func (o *DailyRevenue) GetCurrencies() map[string]CurrencyCode

GetCurrencies returns the Currencies field value.

func (*DailyRevenue) GetCurrenciesOk 

func (o *DailyRevenue) GetCurrenciesOk() (*map[string]CurrencyCode, bool)

GetCurrenciesOk returns a tuple with the Currencies field value and a boolean to check if the value has been set.

func (*DailyRevenue) GetDate 

func (o *DailyRevenue) GetDate() string

GetDate returns the Date field value.

func (*DailyRevenue) GetDateOk 

func (o *DailyRevenue) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (DailyRevenue) MarshalJSON 

func (o DailyRevenue) MarshalJSON() ([]byte, error)

func (*DailyRevenue) SetCurrencies 

func (o *DailyRevenue) SetCurrencies(v map[string]CurrencyCode) *DailyRevenue

SetCurrencies sets field value.

func (*DailyRevenue) SetDate 

func (o *DailyRevenue) SetDate(v string) *DailyRevenue

SetDate sets field value.

func (DailyRevenue) String 

func (o DailyRevenue) String() string

type DailySearches 

type DailySearches struct {
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
	// Number of occurrences.
	Count int32 `json:"count"`
}

DailySearches struct for DailySearches.

func NewDailySearches 

func NewDailySearches(date string, count int32) *DailySearches

NewDailySearches instantiates a new DailySearches object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailySearches 

func NewEmptyDailySearches() *DailySearches

NewEmptyDailySearches return a pointer to an empty DailySearches object.

func (*DailySearches) GetCount 

func (o *DailySearches) GetCount() int32

GetCount returns the Count field value.

func (*DailySearches) GetCountOk 

func (o *DailySearches) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*DailySearches) GetDate 

func (o *DailySearches) GetDate() string

GetDate returns the Date field value.

func (*DailySearches) GetDateOk 

func (o *DailySearches) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (DailySearches) MarshalJSON 

func (o DailySearches) MarshalJSON() ([]byte, error)

func (*DailySearches) SetCount 

func (o *DailySearches) SetCount(v int32) *DailySearches

SetCount sets field value.

func (*DailySearches) SetDate 

func (o *DailySearches) SetDate(v string) *DailySearches

SetDate sets field value.

func (DailySearches) String 

func (o DailySearches) String() string

type DailySearchesNoClicks 

type DailySearchesNoClicks struct {
	// Search query.
	Search string `json:"search"`
	// Number of tracked searches.
	Count int32 `json:"count"`
	// Number of results (hits).
	NbHits int32 `json:"nbHits"`
}

DailySearchesNoClicks struct for DailySearchesNoClicks.

func NewDailySearchesNoClicks 

func NewDailySearchesNoClicks(search string, count int32, nbHits int32) *DailySearchesNoClicks

NewDailySearchesNoClicks instantiates a new DailySearchesNoClicks object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailySearchesNoClicks 

func NewEmptyDailySearchesNoClicks() *DailySearchesNoClicks

NewEmptyDailySearchesNoClicks return a pointer to an empty DailySearchesNoClicks object.

func (*DailySearchesNoClicks) GetCount 

func (o *DailySearchesNoClicks) GetCount() int32

GetCount returns the Count field value.

func (*DailySearchesNoClicks) GetCountOk 

func (o *DailySearchesNoClicks) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*DailySearchesNoClicks) GetNbHits 

func (o *DailySearchesNoClicks) GetNbHits() int32

GetNbHits returns the NbHits field value.

func (*DailySearchesNoClicks) GetNbHitsOk 

func (o *DailySearchesNoClicks) GetNbHitsOk() (*int32, bool)

GetNbHitsOk returns a tuple with the NbHits field value and a boolean to check if the value has been set.

func (*DailySearchesNoClicks) GetSearch 

func (o *DailySearchesNoClicks) GetSearch() string

GetSearch returns the Search field value.

func (*DailySearchesNoClicks) GetSearchOk 

func (o *DailySearchesNoClicks) GetSearchOk() (*string, bool)

GetSearchOk returns a tuple with the Search field value and a boolean to check if the value has been set.

func (DailySearchesNoClicks) MarshalJSON 

func (o DailySearchesNoClicks) MarshalJSON() ([]byte, error)

func (*DailySearchesNoClicks) SetCount 

func (o *DailySearchesNoClicks) SetCount(v int32) *DailySearchesNoClicks

SetCount sets field value.

func (*DailySearchesNoClicks) SetNbHits 

func (o *DailySearchesNoClicks) SetNbHits(v int32) *DailySearchesNoClicks

SetNbHits sets field value.

func (*DailySearchesNoClicks) SetSearch 

func (o *DailySearchesNoClicks) SetSearch(v string) *DailySearchesNoClicks

SetSearch sets field value.

func (DailySearchesNoClicks) String 

func (o DailySearchesNoClicks) String() string

type DailySearchesNoResults 

type DailySearchesNoResults struct {
	// Search query.
	Search string `json:"search"`
	// Number of occurrences.
	Count int32 `json:"count"`
	// Number of searches for this term with applied filters.
	WithFilterCount int32 `json:"withFilterCount"`
}

DailySearchesNoResults struct for DailySearchesNoResults.

func NewDailySearchesNoResults 

func NewDailySearchesNoResults(search string, count int32, withFilterCount int32) *DailySearchesNoResults

NewDailySearchesNoResults instantiates a new DailySearchesNoResults object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailySearchesNoResults 

func NewEmptyDailySearchesNoResults() *DailySearchesNoResults

NewEmptyDailySearchesNoResults return a pointer to an empty DailySearchesNoResults object.

func (*DailySearchesNoResults) GetCount 

func (o *DailySearchesNoResults) GetCount() int32

GetCount returns the Count field value.

func (*DailySearchesNoResults) GetCountOk 

func (o *DailySearchesNoResults) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*DailySearchesNoResults) GetSearch 

func (o *DailySearchesNoResults) GetSearch() string

GetSearch returns the Search field value.

func (*DailySearchesNoResults) GetSearchOk 

func (o *DailySearchesNoResults) GetSearchOk() (*string, bool)

GetSearchOk returns a tuple with the Search field value and a boolean to check if the value has been set.

func (*DailySearchesNoResults) GetWithFilterCount 

func (o *DailySearchesNoResults) GetWithFilterCount() int32

GetWithFilterCount returns the WithFilterCount field value.

func (*DailySearchesNoResults) GetWithFilterCountOk 

func (o *DailySearchesNoResults) GetWithFilterCountOk() (*int32, bool)

GetWithFilterCountOk returns a tuple with the WithFilterCount field value and a boolean to check if the value has been set.

func (DailySearchesNoResults) MarshalJSON 

func (o DailySearchesNoResults) MarshalJSON() ([]byte, error)

func (*DailySearchesNoResults) SetCount 

func (o *DailySearchesNoResults) SetCount(v int32) *DailySearchesNoResults

SetCount sets field value.

func (*DailySearchesNoResults) SetSearch 

func (o *DailySearchesNoResults) SetSearch(v string) *DailySearchesNoResults

SetSearch sets field value.

func (*DailySearchesNoResults) SetWithFilterCount 

func (o *DailySearchesNoResults) SetWithFilterCount(v int32) *DailySearchesNoResults

SetWithFilterCount sets field value.

func (DailySearchesNoResults) String 

func (o DailySearchesNoResults) String() string

type DailyUsers 

type DailyUsers struct {
	// Date in the format YYYY-MM-DD.
	Date string `json:"date"`
	// Number of unique users.
	Count int32 `json:"count"`
}

DailyUsers struct for DailyUsers.

func NewDailyUsers 

func NewDailyUsers(date string, count int32) *DailyUsers

NewDailyUsers instantiates a new DailyUsers object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDailyUsers 

func NewEmptyDailyUsers() *DailyUsers

NewEmptyDailyUsers return a pointer to an empty DailyUsers object.

func (*DailyUsers) GetCount 

func (o *DailyUsers) GetCount() int32

GetCount returns the Count field value.

func (*DailyUsers) GetCountOk 

func (o *DailyUsers) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*DailyUsers) GetDate 

func (o *DailyUsers) GetDate() string

GetDate returns the Date field value.

func (*DailyUsers) GetDateOk 

func (o *DailyUsers) GetDateOk() (*string, bool)

GetDateOk returns a tuple with the Date field value and a boolean to check if the value has been set.

func (DailyUsers) MarshalJSON 

func (o DailyUsers) MarshalJSON() ([]byte, error)

func (*DailyUsers) SetCount 

func (o *DailyUsers) SetCount(v int32) *DailyUsers

SetCount sets field value.

func (*DailyUsers) SetDate 

func (o *DailyUsers) SetDate(v string) *DailyUsers

SetDate sets field value.

func (DailyUsers) String 

func (o DailyUsers) String() string

type Direction 

type Direction string

Direction the model 'Direction'. 

const (
	DIRECTION_ASC  Direction = "asc"
	DIRECTION_DESC Direction = "desc"
)

List of direction.

func NewDirectionFromValue 

func NewDirectionFromValue(v string) (*Direction, error)

NewDirectionFromValue returns a pointer to a valid Direction for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (Direction) IsValid 

func (v Direction) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (Direction) Ptr 

func (v Direction) Ptr() *Direction

Ptr returns reference to direction value.

func (*Direction) UnmarshalJSON 

func (v *Direction) UnmarshalJSON(src []byte) error

type ErrorBase 

type ErrorBase struct {
	Message              *string `json:"message,omitempty"`
	AdditionalProperties map[string]any
}

ErrorBase Error.

func NewEmptyErrorBase 

func NewEmptyErrorBase() *ErrorBase

NewEmptyErrorBase return a pointer to an empty ErrorBase object.

func NewErrorBase 

func NewErrorBase(opts ...ErrorBaseOption) *ErrorBase

NewErrorBase instantiates a new ErrorBase object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ErrorBase) GetMessage 

func (o *ErrorBase) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*ErrorBase) GetMessageOk 

func (o *ErrorBase) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorBase) HasMessage 

func (o *ErrorBase) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (ErrorBase) MarshalJSON 

func (o ErrorBase) MarshalJSON() ([]byte, error)

func (*ErrorBase) SetAdditionalProperty 

func (o *ErrorBase) SetAdditionalProperty(key string, value any) *ErrorBase

func (*ErrorBase) SetMessage 

func (o *ErrorBase) SetMessage(v string) *ErrorBase

SetMessage gets a reference to the given string and assigns it to the Message field.

func (ErrorBase) String 

func (o ErrorBase) String() string

func (*ErrorBase) UnmarshalJSON 

func (o *ErrorBase) UnmarshalJSON(bytes []byte) error

type ErrorBaseOption 

type ErrorBaseOption func(f *ErrorBase)

func WithErrorBaseMessage 

func WithErrorBaseMessage(val string) ErrorBaseOption

type GetAddToCartRateResponse 

type GetAddToCartRateResponse struct {
	// Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Rate utils.Nullable[float64] `json:"rate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Number of add-to-cart events from this search.
	AddToCartCount int32 `json:"addToCartCount"`
	// Daily add-to-cart rates.
	Dates []DailyAddToCartRates `json:"dates"`
}

GetAddToCartRateResponse struct for GetAddToCartRateResponse.

func NewEmptyGetAddToCartRateResponse 

func NewEmptyGetAddToCartRateResponse() *GetAddToCartRateResponse

NewEmptyGetAddToCartRateResponse return a pointer to an empty GetAddToCartRateResponse object.

func NewGetAddToCartRateResponse 

func NewGetAddToCartRateResponse(rate utils.Nullable[float64], trackedSearchCount int32, addToCartCount int32, dates []DailyAddToCartRates) *GetAddToCartRateResponse

NewGetAddToCartRateResponse instantiates a new GetAddToCartRateResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetAddToCartRateResponse) GetAddToCartCount 

func (o *GetAddToCartRateResponse) GetAddToCartCount() int32

GetAddToCartCount returns the AddToCartCount field value.

func (*GetAddToCartRateResponse) GetAddToCartCountOk 

func (o *GetAddToCartRateResponse) GetAddToCartCountOk() (*int32, bool)

GetAddToCartCountOk returns a tuple with the AddToCartCount field value and a boolean to check if the value has been set.

func (*GetAddToCartRateResponse) GetDates 

func (o *GetAddToCartRateResponse) GetDates() []DailyAddToCartRates

GetDates returns the Dates field value.

func (*GetAddToCartRateResponse) GetDatesOk 

func (o *GetAddToCartRateResponse) GetDatesOk() ([]DailyAddToCartRates, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (*GetAddToCartRateResponse) GetRate 

func (o *GetAddToCartRateResponse) GetRate() float64

GetRate returns the Rate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*GetAddToCartRateResponse) GetRateOk 

func (o *GetAddToCartRateResponse) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*GetAddToCartRateResponse) GetTrackedSearchCount 

func (o *GetAddToCartRateResponse) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*GetAddToCartRateResponse) GetTrackedSearchCountOk 

func (o *GetAddToCartRateResponse) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (GetAddToCartRateResponse) MarshalJSON 

func (o GetAddToCartRateResponse) MarshalJSON() ([]byte, error)

func (*GetAddToCartRateResponse) SetAddToCartCount 

func (o *GetAddToCartRateResponse) SetAddToCartCount(v int32) *GetAddToCartRateResponse

SetAddToCartCount sets field value.

func (*GetAddToCartRateResponse) SetDates 

func (o *GetAddToCartRateResponse) SetDates(v []DailyAddToCartRates) *GetAddToCartRateResponse

SetDates sets field value.

func (*GetAddToCartRateResponse) SetRate 

func (o *GetAddToCartRateResponse) SetRate(v float64) *GetAddToCartRateResponse

SetRate sets field value.

func (*GetAddToCartRateResponse) SetTrackedSearchCount 

func (o *GetAddToCartRateResponse) SetTrackedSearchCount(v int32) *GetAddToCartRateResponse

SetTrackedSearchCount sets field value.

func (GetAddToCartRateResponse) String 

func (o GetAddToCartRateResponse) String() string

type GetAverageClickPositionResponse 

type GetAverageClickPositionResponse struct {
	// Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Average utils.Nullable[float64] `json:"average"`
	// Number of clicks associated with this search.
	ClickCount int32 `json:"clickCount"`
	// Daily average click positions.
	Dates []DailyAverageClicks `json:"dates"`
}

GetAverageClickPositionResponse struct for GetAverageClickPositionResponse.

func NewEmptyGetAverageClickPositionResponse 

func NewEmptyGetAverageClickPositionResponse() *GetAverageClickPositionResponse

NewEmptyGetAverageClickPositionResponse return a pointer to an empty GetAverageClickPositionResponse object.

func NewGetAverageClickPositionResponse 

func NewGetAverageClickPositionResponse(average utils.Nullable[float64], clickCount int32, dates []DailyAverageClicks) *GetAverageClickPositionResponse

NewGetAverageClickPositionResponse instantiates a new GetAverageClickPositionResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetAverageClickPositionResponse) GetAverage 

func (o *GetAverageClickPositionResponse) GetAverage() float64

GetAverage returns the Average field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*GetAverageClickPositionResponse) GetAverageOk 

func (o *GetAverageClickPositionResponse) GetAverageOk() (*float64, bool)

GetAverageOk returns a tuple with the Average field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*GetAverageClickPositionResponse) GetClickCount 

func (o *GetAverageClickPositionResponse) GetClickCount() int32

GetClickCount returns the ClickCount field value.

func (*GetAverageClickPositionResponse) GetClickCountOk 

func (o *GetAverageClickPositionResponse) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value and a boolean to check if the value has been set.

func (*GetAverageClickPositionResponse) GetDates 

func (o *GetAverageClickPositionResponse) GetDates() []DailyAverageClicks

GetDates returns the Dates field value.

func (*GetAverageClickPositionResponse) GetDatesOk 

func (o *GetAverageClickPositionResponse) GetDatesOk() ([]DailyAverageClicks, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (GetAverageClickPositionResponse) MarshalJSON 

func (o GetAverageClickPositionResponse) MarshalJSON() ([]byte, error)

func (*GetAverageClickPositionResponse) SetAverage 

func (o *GetAverageClickPositionResponse) SetAverage(v float64) *GetAverageClickPositionResponse

SetAverage sets field value.

func (*GetAverageClickPositionResponse) SetClickCount 

func (o *GetAverageClickPositionResponse) SetClickCount(v int32) *GetAverageClickPositionResponse

SetClickCount sets field value.

func (*GetAverageClickPositionResponse) SetDates 

func (o *GetAverageClickPositionResponse) SetDates(v []DailyAverageClicks) *GetAverageClickPositionResponse

SetDates sets field value.

func (GetAverageClickPositionResponse) String 

func (o GetAverageClickPositionResponse) String() string

type GetClickPositionsResponse 

type GetClickPositionsResponse struct {
	// List of positions in the search results and clicks associated with this search.
	Positions []ClickPosition `json:"positions"`
}

GetClickPositionsResponse struct for GetClickPositionsResponse.

func NewEmptyGetClickPositionsResponse 

func NewEmptyGetClickPositionsResponse() *GetClickPositionsResponse

NewEmptyGetClickPositionsResponse return a pointer to an empty GetClickPositionsResponse object.

func NewGetClickPositionsResponse 

func NewGetClickPositionsResponse(positions []ClickPosition) *GetClickPositionsResponse

NewGetClickPositionsResponse instantiates a new GetClickPositionsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetClickPositionsResponse) GetPositions 

func (o *GetClickPositionsResponse) GetPositions() []ClickPosition

GetPositions returns the Positions field value.

func (*GetClickPositionsResponse) GetPositionsOk 

func (o *GetClickPositionsResponse) GetPositionsOk() ([]ClickPosition, bool)

GetPositionsOk returns a tuple with the Positions field value and a boolean to check if the value has been set.

func (GetClickPositionsResponse) MarshalJSON 

func (o GetClickPositionsResponse) MarshalJSON() ([]byte, error)

func (*GetClickPositionsResponse) SetPositions 

func (o *GetClickPositionsResponse) SetPositions(v []ClickPosition) *GetClickPositionsResponse

SetPositions sets field value.

func (GetClickPositionsResponse) String 

func (o GetClickPositionsResponse) String() string

type GetClickThroughRateResponse 

type GetClickThroughRateResponse struct {
	// Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Rate utils.Nullable[float64] `json:"rate"`
	// Number of clicks associated with this search.
	ClickCount int32 `json:"clickCount"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Daily click-through rates.
	Dates []DailyClickThroughRates `json:"dates"`
}

GetClickThroughRateResponse struct for GetClickThroughRateResponse.

func NewEmptyGetClickThroughRateResponse 

func NewEmptyGetClickThroughRateResponse() *GetClickThroughRateResponse

NewEmptyGetClickThroughRateResponse return a pointer to an empty GetClickThroughRateResponse object.

func NewGetClickThroughRateResponse 

func NewGetClickThroughRateResponse(rate utils.Nullable[float64], clickCount int32, trackedSearchCount int32, dates []DailyClickThroughRates) *GetClickThroughRateResponse

NewGetClickThroughRateResponse instantiates a new GetClickThroughRateResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetClickThroughRateResponse) GetClickCount 

func (o *GetClickThroughRateResponse) GetClickCount() int32

GetClickCount returns the ClickCount field value.

func (*GetClickThroughRateResponse) GetClickCountOk 

func (o *GetClickThroughRateResponse) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value and a boolean to check if the value has been set.

func (*GetClickThroughRateResponse) GetDates 

func (o *GetClickThroughRateResponse) GetDates() []DailyClickThroughRates

GetDates returns the Dates field value.

func (*GetClickThroughRateResponse) GetDatesOk 

func (o *GetClickThroughRateResponse) GetDatesOk() ([]DailyClickThroughRates, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (*GetClickThroughRateResponse) GetRate 

func (o *GetClickThroughRateResponse) GetRate() float64

GetRate returns the Rate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*GetClickThroughRateResponse) GetRateOk 

func (o *GetClickThroughRateResponse) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*GetClickThroughRateResponse) GetTrackedSearchCount 

func (o *GetClickThroughRateResponse) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*GetClickThroughRateResponse) GetTrackedSearchCountOk 

func (o *GetClickThroughRateResponse) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (GetClickThroughRateResponse) MarshalJSON 

func (o GetClickThroughRateResponse) MarshalJSON() ([]byte, error)

func (*GetClickThroughRateResponse) SetClickCount 

func (o *GetClickThroughRateResponse) SetClickCount(v int32) *GetClickThroughRateResponse

SetClickCount sets field value.

func (*GetClickThroughRateResponse) SetDates 

func (o *GetClickThroughRateResponse) SetDates(v []DailyClickThroughRates) *GetClickThroughRateResponse

SetDates sets field value.

func (*GetClickThroughRateResponse) SetRate 

func (o *GetClickThroughRateResponse) SetRate(v float64) *GetClickThroughRateResponse

SetRate sets field value.

func (*GetClickThroughRateResponse) SetTrackedSearchCount 

func (o *GetClickThroughRateResponse) SetTrackedSearchCount(v int32) *GetClickThroughRateResponse

SetTrackedSearchCount sets field value.

func (GetClickThroughRateResponse) String 

func (o GetClickThroughRateResponse) String() string

type GetConversionRateResponse 

type GetConversionRateResponse struct {
	// Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Rate utils.Nullable[float64] `json:"rate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Number of conversions from this search.
	ConversionCount int32 `json:"conversionCount"`
	// Daily conversion rates.
	Dates []DailyConversionRates `json:"dates"`
}

GetConversionRateResponse struct for GetConversionRateResponse.

func NewEmptyGetConversionRateResponse 

func NewEmptyGetConversionRateResponse() *GetConversionRateResponse

NewEmptyGetConversionRateResponse return a pointer to an empty GetConversionRateResponse object.

func NewGetConversionRateResponse 

func NewGetConversionRateResponse(rate utils.Nullable[float64], trackedSearchCount int32, conversionCount int32, dates []DailyConversionRates) *GetConversionRateResponse

NewGetConversionRateResponse instantiates a new GetConversionRateResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetConversionRateResponse) GetConversionCount 

func (o *GetConversionRateResponse) GetConversionCount() int32

GetConversionCount returns the ConversionCount field value.

func (*GetConversionRateResponse) GetConversionCountOk 

func (o *GetConversionRateResponse) GetConversionCountOk() (*int32, bool)

GetConversionCountOk returns a tuple with the ConversionCount field value and a boolean to check if the value has been set.

func (*GetConversionRateResponse) GetDates 

func (o *GetConversionRateResponse) GetDates() []DailyConversionRates

GetDates returns the Dates field value.

func (*GetConversionRateResponse) GetDatesOk 

func (o *GetConversionRateResponse) GetDatesOk() ([]DailyConversionRates, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (*GetConversionRateResponse) GetRate 

func (o *GetConversionRateResponse) GetRate() float64

GetRate returns the Rate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*GetConversionRateResponse) GetRateOk 

func (o *GetConversionRateResponse) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*GetConversionRateResponse) GetTrackedSearchCount 

func (o *GetConversionRateResponse) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*GetConversionRateResponse) GetTrackedSearchCountOk 

func (o *GetConversionRateResponse) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (GetConversionRateResponse) MarshalJSON 

func (o GetConversionRateResponse) MarshalJSON() ([]byte, error)

func (*GetConversionRateResponse) SetConversionCount 

func (o *GetConversionRateResponse) SetConversionCount(v int32) *GetConversionRateResponse

SetConversionCount sets field value.

func (*GetConversionRateResponse) SetDates 

func (o *GetConversionRateResponse) SetDates(v []DailyConversionRates) *GetConversionRateResponse

SetDates sets field value.

func (*GetConversionRateResponse) SetRate 

func (o *GetConversionRateResponse) SetRate(v float64) *GetConversionRateResponse

SetRate sets field value.

func (*GetConversionRateResponse) SetTrackedSearchCount 

func (o *GetConversionRateResponse) SetTrackedSearchCount(v int32) *GetConversionRateResponse

SetTrackedSearchCount sets field value.

func (GetConversionRateResponse) String 

func (o GetConversionRateResponse) String() string

type GetNoClickRateResponse 

type GetNoClickRateResponse struct {
	// No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
	Rate float64 `json:"rate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	Count int32 `json:"count"`
	// Number of times this search was returned as a result without any click.
	NoClickCount int32 `json:"noClickCount"`
	// Daily no click rates.
	Dates []DailyNoClickRates `json:"dates"`
}

GetNoClickRateResponse struct for GetNoClickRateResponse.

func NewEmptyGetNoClickRateResponse 

func NewEmptyGetNoClickRateResponse() *GetNoClickRateResponse

NewEmptyGetNoClickRateResponse return a pointer to an empty GetNoClickRateResponse object.

func NewGetNoClickRateResponse 

func NewGetNoClickRateResponse(rate float64, count int32, noClickCount int32, dates []DailyNoClickRates) *GetNoClickRateResponse

NewGetNoClickRateResponse instantiates a new GetNoClickRateResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetNoClickRateResponse) GetCount 

func (o *GetNoClickRateResponse) GetCount() int32

GetCount returns the Count field value.

func (*GetNoClickRateResponse) GetCountOk 

func (o *GetNoClickRateResponse) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*GetNoClickRateResponse) GetDates 

func (o *GetNoClickRateResponse) GetDates() []DailyNoClickRates

GetDates returns the Dates field value.

func (*GetNoClickRateResponse) GetDatesOk 

func (o *GetNoClickRateResponse) GetDatesOk() ([]DailyNoClickRates, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (*GetNoClickRateResponse) GetNoClickCount 

func (o *GetNoClickRateResponse) GetNoClickCount() int32

GetNoClickCount returns the NoClickCount field value.

func (*GetNoClickRateResponse) GetNoClickCountOk 

func (o *GetNoClickRateResponse) GetNoClickCountOk() (*int32, bool)

GetNoClickCountOk returns a tuple with the NoClickCount field value and a boolean to check if the value has been set.

func (*GetNoClickRateResponse) GetRate 

func (o *GetNoClickRateResponse) GetRate() float64

GetRate returns the Rate field value.

func (*GetNoClickRateResponse) GetRateOk 

func (o *GetNoClickRateResponse) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set.

func (GetNoClickRateResponse) MarshalJSON 

func (o GetNoClickRateResponse) MarshalJSON() ([]byte, error)

func (*GetNoClickRateResponse) SetCount 

func (o *GetNoClickRateResponse) SetCount(v int32) *GetNoClickRateResponse

SetCount sets field value.

func (*GetNoClickRateResponse) SetDates 

func (o *GetNoClickRateResponse) SetDates(v []DailyNoClickRates) *GetNoClickRateResponse

SetDates sets field value.

func (*GetNoClickRateResponse) SetNoClickCount 

func (o *GetNoClickRateResponse) SetNoClickCount(v int32) *GetNoClickRateResponse

SetNoClickCount sets field value.

func (*GetNoClickRateResponse) SetRate 

func (o *GetNoClickRateResponse) SetRate(v float64) *GetNoClickRateResponse

SetRate sets field value.

func (GetNoClickRateResponse) String 

func (o GetNoClickRateResponse) String() string

type GetNoResultsRateResponse 

type GetNoResultsRateResponse struct {
	// No results rate, calculated as number of searches with zero results divided by the total number of searches.
	Rate float64 `json:"rate"`
	// Number of searches.
	Count int32 `json:"count"`
	// Number of searches without any results.
	NoResultCount int32 `json:"noResultCount"`
	// Daily no results rates.
	Dates []DailyNoResultsRates `json:"dates"`
}

GetNoResultsRateResponse struct for GetNoResultsRateResponse.

func NewEmptyGetNoResultsRateResponse 

func NewEmptyGetNoResultsRateResponse() *GetNoResultsRateResponse

NewEmptyGetNoResultsRateResponse return a pointer to an empty GetNoResultsRateResponse object.

func NewGetNoResultsRateResponse 

func NewGetNoResultsRateResponse(rate float64, count int32, noResultCount int32, dates []DailyNoResultsRates) *GetNoResultsRateResponse

NewGetNoResultsRateResponse instantiates a new GetNoResultsRateResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetNoResultsRateResponse) GetCount 

func (o *GetNoResultsRateResponse) GetCount() int32

GetCount returns the Count field value.

func (*GetNoResultsRateResponse) GetCountOk 

func (o *GetNoResultsRateResponse) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*GetNoResultsRateResponse) GetDates 

func (o *GetNoResultsRateResponse) GetDates() []DailyNoResultsRates

GetDates returns the Dates field value.

func (*GetNoResultsRateResponse) GetDatesOk 

func (o *GetNoResultsRateResponse) GetDatesOk() ([]DailyNoResultsRates, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (*GetNoResultsRateResponse) GetNoResultCount 

func (o *GetNoResultsRateResponse) GetNoResultCount() int32

GetNoResultCount returns the NoResultCount field value.

func (*GetNoResultsRateResponse) GetNoResultCountOk 

func (o *GetNoResultsRateResponse) GetNoResultCountOk() (*int32, bool)

GetNoResultCountOk returns a tuple with the NoResultCount field value and a boolean to check if the value has been set.

func (*GetNoResultsRateResponse) GetRate 

func (o *GetNoResultsRateResponse) GetRate() float64

GetRate returns the Rate field value.

func (*GetNoResultsRateResponse) GetRateOk 

func (o *GetNoResultsRateResponse) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set.

func (GetNoResultsRateResponse) MarshalJSON 

func (o GetNoResultsRateResponse) MarshalJSON() ([]byte, error)

func (*GetNoResultsRateResponse) SetCount 

func (o *GetNoResultsRateResponse) SetCount(v int32) *GetNoResultsRateResponse

SetCount sets field value.

func (*GetNoResultsRateResponse) SetDates 

func (o *GetNoResultsRateResponse) SetDates(v []DailyNoResultsRates) *GetNoResultsRateResponse

SetDates sets field value.

func (*GetNoResultsRateResponse) SetNoResultCount 

func (o *GetNoResultsRateResponse) SetNoResultCount(v int32) *GetNoResultsRateResponse

SetNoResultCount sets field value.

func (*GetNoResultsRateResponse) SetRate 

func (o *GetNoResultsRateResponse) SetRate(v float64) *GetNoResultsRateResponse

SetRate sets field value.

func (GetNoResultsRateResponse) String 

func (o GetNoResultsRateResponse) String() string

type GetPurchaseRateResponse 

type GetPurchaseRateResponse struct {
	// Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	Rate utils.Nullable[float64] `json:"rate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Number of purchase events from this search.
	PurchaseCount int32 `json:"purchaseCount"`
	// Daily purchase rates.
	Dates []DailyPurchaseRates `json:"dates"`
}

GetPurchaseRateResponse struct for GetPurchaseRateResponse.

func NewEmptyGetPurchaseRateResponse 

func NewEmptyGetPurchaseRateResponse() *GetPurchaseRateResponse

NewEmptyGetPurchaseRateResponse return a pointer to an empty GetPurchaseRateResponse object.

func NewGetPurchaseRateResponse 

func NewGetPurchaseRateResponse(rate utils.Nullable[float64], trackedSearchCount int32, purchaseCount int32, dates []DailyPurchaseRates) *GetPurchaseRateResponse

NewGetPurchaseRateResponse instantiates a new GetPurchaseRateResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetPurchaseRateResponse) GetDates 

func (o *GetPurchaseRateResponse) GetDates() []DailyPurchaseRates

GetDates returns the Dates field value.

func (*GetPurchaseRateResponse) GetDatesOk 

func (o *GetPurchaseRateResponse) GetDatesOk() ([]DailyPurchaseRates, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (*GetPurchaseRateResponse) GetPurchaseCount 

func (o *GetPurchaseRateResponse) GetPurchaseCount() int32

GetPurchaseCount returns the PurchaseCount field value.

func (*GetPurchaseRateResponse) GetPurchaseCountOk 

func (o *GetPurchaseRateResponse) GetPurchaseCountOk() (*int32, bool)

GetPurchaseCountOk returns a tuple with the PurchaseCount field value and a boolean to check if the value has been set.

func (*GetPurchaseRateResponse) GetRate 

func (o *GetPurchaseRateResponse) GetRate() float64

GetRate returns the Rate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*GetPurchaseRateResponse) GetRateOk 

func (o *GetPurchaseRateResponse) GetRateOk() (*float64, bool)

GetRateOk returns a tuple with the Rate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*GetPurchaseRateResponse) GetTrackedSearchCount 

func (o *GetPurchaseRateResponse) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*GetPurchaseRateResponse) GetTrackedSearchCountOk 

func (o *GetPurchaseRateResponse) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (GetPurchaseRateResponse) MarshalJSON 

func (o GetPurchaseRateResponse) MarshalJSON() ([]byte, error)

func (*GetPurchaseRateResponse) SetDates 

func (o *GetPurchaseRateResponse) SetDates(v []DailyPurchaseRates) *GetPurchaseRateResponse

SetDates sets field value.

func (*GetPurchaseRateResponse) SetPurchaseCount 

func (o *GetPurchaseRateResponse) SetPurchaseCount(v int32) *GetPurchaseRateResponse

SetPurchaseCount sets field value.

func (*GetPurchaseRateResponse) SetRate 

func (o *GetPurchaseRateResponse) SetRate(v float64) *GetPurchaseRateResponse

SetRate sets field value.

func (*GetPurchaseRateResponse) SetTrackedSearchCount 

func (o *GetPurchaseRateResponse) SetTrackedSearchCount(v int32) *GetPurchaseRateResponse

SetTrackedSearchCount sets field value.

func (GetPurchaseRateResponse) String 

func (o GetPurchaseRateResponse) String() string

type GetRevenue 

type GetRevenue struct {
	// Revenue associated with this search, broken-down by currencies.
	Currencies map[string]CurrencyCode `json:"currencies"`
	// Daily revenue.
	Dates []DailyRevenue `json:"dates"`
}

GetRevenue struct for GetRevenue.

func NewEmptyGetRevenue 

func NewEmptyGetRevenue() *GetRevenue

NewEmptyGetRevenue return a pointer to an empty GetRevenue object.

func NewGetRevenue 

func NewGetRevenue(currencies map[string]CurrencyCode, dates []DailyRevenue) *GetRevenue

NewGetRevenue instantiates a new GetRevenue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetRevenue) GetCurrencies 

func (o *GetRevenue) GetCurrencies() map[string]CurrencyCode

GetCurrencies returns the Currencies field value.

func (*GetRevenue) GetCurrenciesOk 

func (o *GetRevenue) GetCurrenciesOk() (*map[string]CurrencyCode, bool)

GetCurrenciesOk returns a tuple with the Currencies field value and a boolean to check if the value has been set.

func (*GetRevenue) GetDates 

func (o *GetRevenue) GetDates() []DailyRevenue

GetDates returns the Dates field value.

func (*GetRevenue) GetDatesOk 

func (o *GetRevenue) GetDatesOk() ([]DailyRevenue, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (GetRevenue) MarshalJSON 

func (o GetRevenue) MarshalJSON() ([]byte, error)

func (*GetRevenue) SetCurrencies 

func (o *GetRevenue) SetCurrencies(v map[string]CurrencyCode) *GetRevenue

SetCurrencies sets field value.

func (*GetRevenue) SetDates 

func (o *GetRevenue) SetDates(v []DailyRevenue) *GetRevenue

SetDates sets field value.

func (GetRevenue) String 

func (o GetRevenue) String() string

type GetSearchesCountResponse 

type GetSearchesCountResponse struct {
	// Number of occurrences.
	Count int32 `json:"count"`
	// Daily number of searches.
	Dates []DailySearches `json:"dates"`
}

GetSearchesCountResponse struct for GetSearchesCountResponse.

func NewEmptyGetSearchesCountResponse 

func NewEmptyGetSearchesCountResponse() *GetSearchesCountResponse

NewEmptyGetSearchesCountResponse return a pointer to an empty GetSearchesCountResponse object.

func NewGetSearchesCountResponse 

func NewGetSearchesCountResponse(count int32, dates []DailySearches) *GetSearchesCountResponse

NewGetSearchesCountResponse instantiates a new GetSearchesCountResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetSearchesCountResponse) GetCount 

func (o *GetSearchesCountResponse) GetCount() int32

GetCount returns the Count field value.

func (*GetSearchesCountResponse) GetCountOk 

func (o *GetSearchesCountResponse) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*GetSearchesCountResponse) GetDates 

func (o *GetSearchesCountResponse) GetDates() []DailySearches

GetDates returns the Dates field value.

func (*GetSearchesCountResponse) GetDatesOk 

func (o *GetSearchesCountResponse) GetDatesOk() ([]DailySearches, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (GetSearchesCountResponse) MarshalJSON 

func (o GetSearchesCountResponse) MarshalJSON() ([]byte, error)

func (*GetSearchesCountResponse) SetCount 

func (o *GetSearchesCountResponse) SetCount(v int32) *GetSearchesCountResponse

SetCount sets field value.

func (*GetSearchesCountResponse) SetDates 

func (o *GetSearchesCountResponse) SetDates(v []DailySearches) *GetSearchesCountResponse

SetDates sets field value.

func (GetSearchesCountResponse) String 

func (o GetSearchesCountResponse) String() string

type GetSearchesNoClicksResponse 

type GetSearchesNoClicksResponse struct {
	// Searches without any clicks.
	Searches []DailySearchesNoClicks `json:"searches"`
}

GetSearchesNoClicksResponse struct for GetSearchesNoClicksResponse.

func NewEmptyGetSearchesNoClicksResponse 

func NewEmptyGetSearchesNoClicksResponse() *GetSearchesNoClicksResponse

NewEmptyGetSearchesNoClicksResponse return a pointer to an empty GetSearchesNoClicksResponse object.

func NewGetSearchesNoClicksResponse 

func NewGetSearchesNoClicksResponse(searches []DailySearchesNoClicks) *GetSearchesNoClicksResponse

NewGetSearchesNoClicksResponse instantiates a new GetSearchesNoClicksResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetSearchesNoClicksResponse) GetSearches 

func (o *GetSearchesNoClicksResponse) GetSearches() []DailySearchesNoClicks

GetSearches returns the Searches field value.

func (*GetSearchesNoClicksResponse) GetSearchesOk 

func (o *GetSearchesNoClicksResponse) GetSearchesOk() ([]DailySearchesNoClicks, bool)

GetSearchesOk returns a tuple with the Searches field value and a boolean to check if the value has been set.

func (GetSearchesNoClicksResponse) MarshalJSON 

func (o GetSearchesNoClicksResponse) MarshalJSON() ([]byte, error)

func (*GetSearchesNoClicksResponse) SetSearches 

func (o *GetSearchesNoClicksResponse) SetSearches(v []DailySearchesNoClicks) *GetSearchesNoClicksResponse

SetSearches sets field value.

func (GetSearchesNoClicksResponse) String 

func (o GetSearchesNoClicksResponse) String() string

type GetSearchesNoResultsResponse 

type GetSearchesNoResultsResponse struct {
	// Searches without results.
	Searches []DailySearchesNoResults `json:"searches"`
}

GetSearchesNoResultsResponse struct for GetSearchesNoResultsResponse.

func NewEmptyGetSearchesNoResultsResponse 

func NewEmptyGetSearchesNoResultsResponse() *GetSearchesNoResultsResponse

NewEmptyGetSearchesNoResultsResponse return a pointer to an empty GetSearchesNoResultsResponse object.

func NewGetSearchesNoResultsResponse 

func NewGetSearchesNoResultsResponse(searches []DailySearchesNoResults) *GetSearchesNoResultsResponse

NewGetSearchesNoResultsResponse instantiates a new GetSearchesNoResultsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetSearchesNoResultsResponse) GetSearches 

func (o *GetSearchesNoResultsResponse) GetSearches() []DailySearchesNoResults

GetSearches returns the Searches field value.

func (*GetSearchesNoResultsResponse) GetSearchesOk 

func (o *GetSearchesNoResultsResponse) GetSearchesOk() ([]DailySearchesNoResults, bool)

GetSearchesOk returns a tuple with the Searches field value and a boolean to check if the value has been set.

func (GetSearchesNoResultsResponse) MarshalJSON 

func (o GetSearchesNoResultsResponse) MarshalJSON() ([]byte, error)

func (*GetSearchesNoResultsResponse) SetSearches 

func (o *GetSearchesNoResultsResponse) SetSearches(v []DailySearchesNoResults) *GetSearchesNoResultsResponse

SetSearches sets field value.

func (GetSearchesNoResultsResponse) String 

func (o GetSearchesNoResultsResponse) String() string

type GetStatusResponse 

type GetStatusResponse struct {
	// Date and time when the object was updated, in RFC 3339 format.
	UpdatedAt utils.Nullable[string] `json:"updatedAt"`
}

GetStatusResponse struct for GetStatusResponse.

func NewEmptyGetStatusResponse 

func NewEmptyGetStatusResponse() *GetStatusResponse

NewEmptyGetStatusResponse return a pointer to an empty GetStatusResponse object.

func NewGetStatusResponse 

func NewGetStatusResponse(updatedAt utils.Nullable[string]) *GetStatusResponse

NewGetStatusResponse instantiates a new GetStatusResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetStatusResponse) GetUpdatedAt 

func (o *GetStatusResponse) GetUpdatedAt() string

GetUpdatedAt returns the UpdatedAt field value. If the value is explicit nil, the zero value for string will be returned.

func (*GetStatusResponse) GetUpdatedAtOk 

func (o *GetStatusResponse) GetUpdatedAtOk() (*string, bool)

GetUpdatedAtOk returns a tuple with the UpdatedAt field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (GetStatusResponse) MarshalJSON 

func (o GetStatusResponse) MarshalJSON() ([]byte, error)

func (*GetStatusResponse) SetUpdatedAt 

func (o *GetStatusResponse) SetUpdatedAt(v string) *GetStatusResponse

SetUpdatedAt sets field value.

func (GetStatusResponse) String 

func (o GetStatusResponse) String() string

type GetTopCountriesResponse 

type GetTopCountriesResponse struct {
	// Countries and number of searches.
	Countries []TopCountry `json:"countries"`
}

GetTopCountriesResponse struct for GetTopCountriesResponse.

func NewEmptyGetTopCountriesResponse 

func NewEmptyGetTopCountriesResponse() *GetTopCountriesResponse

NewEmptyGetTopCountriesResponse return a pointer to an empty GetTopCountriesResponse object.

func NewGetTopCountriesResponse 

func NewGetTopCountriesResponse(countries []TopCountry) *GetTopCountriesResponse

NewGetTopCountriesResponse instantiates a new GetTopCountriesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTopCountriesResponse) GetCountries 

func (o *GetTopCountriesResponse) GetCountries() []TopCountry

GetCountries returns the Countries field value.

func (*GetTopCountriesResponse) GetCountriesOk 

func (o *GetTopCountriesResponse) GetCountriesOk() ([]TopCountry, bool)

GetCountriesOk returns a tuple with the Countries field value and a boolean to check if the value has been set.

func (GetTopCountriesResponse) MarshalJSON 

func (o GetTopCountriesResponse) MarshalJSON() ([]byte, error)

func (*GetTopCountriesResponse) SetCountries 

func (o *GetTopCountriesResponse) SetCountries(v []TopCountry) *GetTopCountriesResponse

SetCountries sets field value.

func (GetTopCountriesResponse) String 

func (o GetTopCountriesResponse) String() string

type GetTopFilterAttribute 

type GetTopFilterAttribute struct {
	// Attribute name.
	Attribute string `json:"attribute"`
	// Number of occurrences.
	Count int32 `json:"count"`
}

GetTopFilterAttribute struct for GetTopFilterAttribute.

func NewEmptyGetTopFilterAttribute 

func NewEmptyGetTopFilterAttribute() *GetTopFilterAttribute

NewEmptyGetTopFilterAttribute return a pointer to an empty GetTopFilterAttribute object.

func NewGetTopFilterAttribute 

func NewGetTopFilterAttribute(attribute string, count int32) *GetTopFilterAttribute

NewGetTopFilterAttribute instantiates a new GetTopFilterAttribute object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTopFilterAttribute) GetAttribute 

func (o *GetTopFilterAttribute) GetAttribute() string

GetAttribute returns the Attribute field value.

func (*GetTopFilterAttribute) GetAttributeOk 

func (o *GetTopFilterAttribute) GetAttributeOk() (*string, bool)

GetAttributeOk returns a tuple with the Attribute field value and a boolean to check if the value has been set.

func (*GetTopFilterAttribute) GetCount 

func (o *GetTopFilterAttribute) GetCount() int32

GetCount returns the Count field value.

func (*GetTopFilterAttribute) GetCountOk 

func (o *GetTopFilterAttribute) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (GetTopFilterAttribute) MarshalJSON 

func (o GetTopFilterAttribute) MarshalJSON() ([]byte, error)

func (*GetTopFilterAttribute) SetAttribute 

func (o *GetTopFilterAttribute) SetAttribute(v string) *GetTopFilterAttribute

SetAttribute sets field value.

func (*GetTopFilterAttribute) SetCount 

func (o *GetTopFilterAttribute) SetCount(v int32) *GetTopFilterAttribute

SetCount sets field value.

func (GetTopFilterAttribute) String 

func (o GetTopFilterAttribute) String() string

type GetTopFilterAttributesResponse 

type GetTopFilterAttributesResponse struct {
	// Most frequent filters.
	Attributes []GetTopFilterAttribute `json:"attributes"`
}

GetTopFilterAttributesResponse struct for GetTopFilterAttributesResponse.

func NewEmptyGetTopFilterAttributesResponse 

func NewEmptyGetTopFilterAttributesResponse() *GetTopFilterAttributesResponse

NewEmptyGetTopFilterAttributesResponse return a pointer to an empty GetTopFilterAttributesResponse object.

func NewGetTopFilterAttributesResponse 

func NewGetTopFilterAttributesResponse(attributes []GetTopFilterAttribute) *GetTopFilterAttributesResponse

NewGetTopFilterAttributesResponse instantiates a new GetTopFilterAttributesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTopFilterAttributesResponse) GetAttributes 

func (o *GetTopFilterAttributesResponse) GetAttributes() []GetTopFilterAttribute

GetAttributes returns the Attributes field value.

func (*GetTopFilterAttributesResponse) GetAttributesOk 

func (o *GetTopFilterAttributesResponse) GetAttributesOk() ([]GetTopFilterAttribute, bool)

GetAttributesOk returns a tuple with the Attributes field value and a boolean to check if the value has been set.

func (GetTopFilterAttributesResponse) MarshalJSON 

func (o GetTopFilterAttributesResponse) MarshalJSON() ([]byte, error)

func (*GetTopFilterAttributesResponse) SetAttributes 

func (o *GetTopFilterAttributesResponse) SetAttributes(v []GetTopFilterAttribute) *GetTopFilterAttributesResponse

SetAttributes sets field value.

func (GetTopFilterAttributesResponse) String 

func (o GetTopFilterAttributesResponse) String() string

type GetTopFilterForAttribute 

type GetTopFilterForAttribute struct {
	// Attribute name.
	Attribute string   `json:"attribute"`
	Operator  Operator `json:"operator"`
	// Attribute value.
	Value string `json:"value"`
	// Number of occurrences.
	Count int32 `json:"count"`
}

GetTopFilterForAttribute struct for GetTopFilterForAttribute.

func NewEmptyGetTopFilterForAttribute 

func NewEmptyGetTopFilterForAttribute() *GetTopFilterForAttribute

NewEmptyGetTopFilterForAttribute return a pointer to an empty GetTopFilterForAttribute object.

func NewGetTopFilterForAttribute 

func NewGetTopFilterForAttribute(attribute string, operator Operator, value string, count int32) *GetTopFilterForAttribute

NewGetTopFilterForAttribute instantiates a new GetTopFilterForAttribute object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTopFilterForAttribute) GetAttribute 

func (o *GetTopFilterForAttribute) GetAttribute() string

GetAttribute returns the Attribute field value.

func (*GetTopFilterForAttribute) GetAttributeOk 

func (o *GetTopFilterForAttribute) GetAttributeOk() (*string, bool)

GetAttributeOk returns a tuple with the Attribute field value and a boolean to check if the value has been set.

func (*GetTopFilterForAttribute) GetCount 

func (o *GetTopFilterForAttribute) GetCount() int32

GetCount returns the Count field value.

func (*GetTopFilterForAttribute) GetCountOk 

func (o *GetTopFilterForAttribute) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*GetTopFilterForAttribute) GetOperator 

func (o *GetTopFilterForAttribute) GetOperator() Operator

GetOperator returns the Operator field value.

func (*GetTopFilterForAttribute) GetOperatorOk 

func (o *GetTopFilterForAttribute) GetOperatorOk() (*Operator, bool)

GetOperatorOk returns a tuple with the Operator field value and a boolean to check if the value has been set.

func (*GetTopFilterForAttribute) GetValue 

func (o *GetTopFilterForAttribute) GetValue() string

GetValue returns the Value field value.

func (*GetTopFilterForAttribute) GetValueOk 

func (o *GetTopFilterForAttribute) GetValueOk() (*string, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (GetTopFilterForAttribute) MarshalJSON 

func (o GetTopFilterForAttribute) MarshalJSON() ([]byte, error)

func (*GetTopFilterForAttribute) SetAttribute 

func (o *GetTopFilterForAttribute) SetAttribute(v string) *GetTopFilterForAttribute

SetAttribute sets field value.

func (*GetTopFilterForAttribute) SetCount 

func (o *GetTopFilterForAttribute) SetCount(v int32) *GetTopFilterForAttribute

SetCount sets field value.

func (*GetTopFilterForAttribute) SetOperator 

func (o *GetTopFilterForAttribute) SetOperator(v Operator) *GetTopFilterForAttribute

SetOperator sets field value.

func (*GetTopFilterForAttribute) SetValue 

func (o *GetTopFilterForAttribute) SetValue(v string) *GetTopFilterForAttribute

SetValue sets field value.

func (GetTopFilterForAttribute) String 

func (o GetTopFilterForAttribute) String() string

type GetTopFilterForAttributeResponse 

type GetTopFilterForAttributeResponse struct {
	// Filter values for an attribute.
	Values []GetTopFilterForAttribute `json:"values"`
}

GetTopFilterForAttributeResponse struct for GetTopFilterForAttributeResponse.

func NewEmptyGetTopFilterForAttributeResponse 

func NewEmptyGetTopFilterForAttributeResponse() *GetTopFilterForAttributeResponse

NewEmptyGetTopFilterForAttributeResponse return a pointer to an empty GetTopFilterForAttributeResponse object.

func NewGetTopFilterForAttributeResponse 

func NewGetTopFilterForAttributeResponse(values []GetTopFilterForAttribute) *GetTopFilterForAttributeResponse

NewGetTopFilterForAttributeResponse instantiates a new GetTopFilterForAttributeResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTopFilterForAttributeResponse) GetValues 

func (o *GetTopFilterForAttributeResponse) GetValues() []GetTopFilterForAttribute

GetValues returns the Values field value.

func (*GetTopFilterForAttributeResponse) GetValuesOk 

func (o *GetTopFilterForAttributeResponse) GetValuesOk() ([]GetTopFilterForAttribute, bool)

GetValuesOk returns a tuple with the Values field value and a boolean to check if the value has been set.

func (GetTopFilterForAttributeResponse) MarshalJSON 

func (o GetTopFilterForAttributeResponse) MarshalJSON() ([]byte, error)

func (*GetTopFilterForAttributeResponse) SetValues 

func (o *GetTopFilterForAttributeResponse) SetValues(v []GetTopFilterForAttribute) *GetTopFilterForAttributeResponse

SetValues sets field value.

func (GetTopFilterForAttributeResponse) String 

func (o GetTopFilterForAttributeResponse) String() string

type GetTopFiltersNoResultsResponse 

type GetTopFiltersNoResultsResponse struct {
	// Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request.
	Values []GetTopFiltersNoResultsValues `json:"values"`
}

GetTopFiltersNoResultsResponse struct for GetTopFiltersNoResultsResponse.

func NewEmptyGetTopFiltersNoResultsResponse 

func NewEmptyGetTopFiltersNoResultsResponse() *GetTopFiltersNoResultsResponse

NewEmptyGetTopFiltersNoResultsResponse return a pointer to an empty GetTopFiltersNoResultsResponse object.

func NewGetTopFiltersNoResultsResponse 

func NewGetTopFiltersNoResultsResponse(values []GetTopFiltersNoResultsValues) *GetTopFiltersNoResultsResponse

NewGetTopFiltersNoResultsResponse instantiates a new GetTopFiltersNoResultsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTopFiltersNoResultsResponse) GetValues 

func (o *GetTopFiltersNoResultsResponse) GetValues() []GetTopFiltersNoResultsValues

GetValues returns the Values field value. If the value is explicit nil, the zero value for []GetTopFiltersNoResultsValues will be returned.

func (*GetTopFiltersNoResultsResponse) GetValuesOk 

func (o *GetTopFiltersNoResultsResponse) GetValuesOk() ([]GetTopFiltersNoResultsValues, bool)

GetValuesOk returns a tuple with the Values field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (GetTopFiltersNoResultsResponse) MarshalJSON 

func (o GetTopFiltersNoResultsResponse) MarshalJSON() ([]byte, error)

func (*GetTopFiltersNoResultsResponse) SetValues 

func (o *GetTopFiltersNoResultsResponse) SetValues(v []GetTopFiltersNoResultsValues) *GetTopFiltersNoResultsResponse

SetValues sets field value.

func (GetTopFiltersNoResultsResponse) String 

func (o GetTopFiltersNoResultsResponse) String() string

type GetTopFiltersNoResultsValue 

type GetTopFiltersNoResultsValue struct {
	// Attribute name.
	Attribute string   `json:"attribute"`
	Operator  Operator `json:"operator"`
	// Attribute value.
	Value string `json:"value"`
}

GetTopFiltersNoResultsValue struct for GetTopFiltersNoResultsValue.

func NewEmptyGetTopFiltersNoResultsValue 

func NewEmptyGetTopFiltersNoResultsValue() *GetTopFiltersNoResultsValue

NewEmptyGetTopFiltersNoResultsValue return a pointer to an empty GetTopFiltersNoResultsValue object.

func NewGetTopFiltersNoResultsValue 

func NewGetTopFiltersNoResultsValue(attribute string, operator Operator, value string) *GetTopFiltersNoResultsValue

NewGetTopFiltersNoResultsValue instantiates a new GetTopFiltersNoResultsValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTopFiltersNoResultsValue) GetAttribute 

func (o *GetTopFiltersNoResultsValue) GetAttribute() string

GetAttribute returns the Attribute field value.

func (*GetTopFiltersNoResultsValue) GetAttributeOk 

func (o *GetTopFiltersNoResultsValue) GetAttributeOk() (*string, bool)

GetAttributeOk returns a tuple with the Attribute field value and a boolean to check if the value has been set.

func (*GetTopFiltersNoResultsValue) GetOperator 

func (o *GetTopFiltersNoResultsValue) GetOperator() Operator

GetOperator returns the Operator field value.

func (*GetTopFiltersNoResultsValue) GetOperatorOk 

func (o *GetTopFiltersNoResultsValue) GetOperatorOk() (*Operator, bool)

GetOperatorOk returns a tuple with the Operator field value and a boolean to check if the value has been set.

func (*GetTopFiltersNoResultsValue) GetValue 

func (o *GetTopFiltersNoResultsValue) GetValue() string

GetValue returns the Value field value.

func (*GetTopFiltersNoResultsValue) GetValueOk 

func (o *GetTopFiltersNoResultsValue) GetValueOk() (*string, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (GetTopFiltersNoResultsValue) MarshalJSON 

func (o GetTopFiltersNoResultsValue) MarshalJSON() ([]byte, error)

func (*GetTopFiltersNoResultsValue) SetAttribute 

func (o *GetTopFiltersNoResultsValue) SetAttribute(v string) *GetTopFiltersNoResultsValue

SetAttribute sets field value.

func (*GetTopFiltersNoResultsValue) SetOperator 

func (o *GetTopFiltersNoResultsValue) SetOperator(v Operator) *GetTopFiltersNoResultsValue

SetOperator sets field value.

func (*GetTopFiltersNoResultsValue) SetValue 

func (o *GetTopFiltersNoResultsValue) SetValue(v string) *GetTopFiltersNoResultsValue

SetValue sets field value.

func (GetTopFiltersNoResultsValue) String 

func (o GetTopFiltersNoResultsValue) String() string

type GetTopFiltersNoResultsValues 

type GetTopFiltersNoResultsValues struct {
	// Number of occurrences.
	Count int32 `json:"count"`
	// Filters with no results.
	Values []GetTopFiltersNoResultsValue `json:"values"`
}

GetTopFiltersNoResultsValues struct for GetTopFiltersNoResultsValues.

func NewEmptyGetTopFiltersNoResultsValues 

func NewEmptyGetTopFiltersNoResultsValues() *GetTopFiltersNoResultsValues

NewEmptyGetTopFiltersNoResultsValues return a pointer to an empty GetTopFiltersNoResultsValues object.

func NewGetTopFiltersNoResultsValues 

func NewGetTopFiltersNoResultsValues(count int32, values []GetTopFiltersNoResultsValue) *GetTopFiltersNoResultsValues

NewGetTopFiltersNoResultsValues instantiates a new GetTopFiltersNoResultsValues object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTopFiltersNoResultsValues) GetCount 

func (o *GetTopFiltersNoResultsValues) GetCount() int32

GetCount returns the Count field value.

func (*GetTopFiltersNoResultsValues) GetCountOk 

func (o *GetTopFiltersNoResultsValues) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*GetTopFiltersNoResultsValues) GetValues 

func (o *GetTopFiltersNoResultsValues) GetValues() []GetTopFiltersNoResultsValue

GetValues returns the Values field value.

func (*GetTopFiltersNoResultsValues) GetValuesOk 

func (o *GetTopFiltersNoResultsValues) GetValuesOk() ([]GetTopFiltersNoResultsValue, bool)

GetValuesOk returns a tuple with the Values field value and a boolean to check if the value has been set.

func (GetTopFiltersNoResultsValues) MarshalJSON 

func (o GetTopFiltersNoResultsValues) MarshalJSON() ([]byte, error)

func (*GetTopFiltersNoResultsValues) SetCount 

func (o *GetTopFiltersNoResultsValues) SetCount(v int32) *GetTopFiltersNoResultsValues

SetCount sets field value.

func (*GetTopFiltersNoResultsValues) SetValues 

func (o *GetTopFiltersNoResultsValues) SetValues(v []GetTopFiltersNoResultsValue) *GetTopFiltersNoResultsValues

SetValues sets field value.

func (GetTopFiltersNoResultsValues) String 

func (o GetTopFiltersNoResultsValues) String() string

type GetTopHitsResponse 

type GetTopHitsResponse struct {
	TopHitsResponse                     *TopHitsResponse
	TopHitsResponseWithAnalytics        *TopHitsResponseWithAnalytics
	TopHitsResponseWithRevenueAnalytics *TopHitsResponseWithRevenueAnalytics
}

GetTopHitsResponse - struct for GetTopHitsResponse.

func TopHitsResponseAsGetTopHitsResponse 

func TopHitsResponseAsGetTopHitsResponse(v *TopHitsResponse) *GetTopHitsResponse

TopHitsResponseAsGetTopHitsResponse is a convenience function that returns TopHitsResponse wrapped in GetTopHitsResponse.

func TopHitsResponseWithAnalyticsAsGetTopHitsResponse 

func TopHitsResponseWithAnalyticsAsGetTopHitsResponse(v *TopHitsResponseWithAnalytics) *GetTopHitsResponse

TopHitsResponseWithAnalyticsAsGetTopHitsResponse is a convenience function that returns TopHitsResponseWithAnalytics wrapped in GetTopHitsResponse.

func TopHitsResponseWithRevenueAnalyticsAsGetTopHitsResponse 

func TopHitsResponseWithRevenueAnalyticsAsGetTopHitsResponse(v *TopHitsResponseWithRevenueAnalytics) *GetTopHitsResponse

TopHitsResponseWithRevenueAnalyticsAsGetTopHitsResponse is a convenience function that returns TopHitsResponseWithRevenueAnalytics wrapped in GetTopHitsResponse.

func (GetTopHitsResponse) GetActualInstance 

func (obj GetTopHitsResponse) GetActualInstance() any

Get the actual instance.

func (GetTopHitsResponse) MarshalJSON 

func (src GetTopHitsResponse) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*GetTopHitsResponse) UnmarshalJSON 

func (dst *GetTopHitsResponse) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct.

type GetTopSearchesResponse 

type GetTopSearchesResponse struct {
	TopSearchesResponse                     *TopSearchesResponse
	TopSearchesResponseWithAnalytics        *TopSearchesResponseWithAnalytics
	TopSearchesResponseWithRevenueAnalytics *TopSearchesResponseWithRevenueAnalytics
}

GetTopSearchesResponse - struct for GetTopSearchesResponse.

func TopSearchesResponseAsGetTopSearchesResponse 

func TopSearchesResponseAsGetTopSearchesResponse(v *TopSearchesResponse) *GetTopSearchesResponse

TopSearchesResponseAsGetTopSearchesResponse is a convenience function that returns TopSearchesResponse wrapped in GetTopSearchesResponse.

func TopSearchesResponseWithAnalyticsAsGetTopSearchesResponse 

func TopSearchesResponseWithAnalyticsAsGetTopSearchesResponse(v *TopSearchesResponseWithAnalytics) *GetTopSearchesResponse

TopSearchesResponseWithAnalyticsAsGetTopSearchesResponse is a convenience function that returns TopSearchesResponseWithAnalytics wrapped in GetTopSearchesResponse.

func TopSearchesResponseWithRevenueAnalyticsAsGetTopSearchesResponse 

func TopSearchesResponseWithRevenueAnalyticsAsGetTopSearchesResponse(v *TopSearchesResponseWithRevenueAnalytics) *GetTopSearchesResponse

TopSearchesResponseWithRevenueAnalyticsAsGetTopSearchesResponse is a convenience function that returns TopSearchesResponseWithRevenueAnalytics wrapped in GetTopSearchesResponse.

func (GetTopSearchesResponse) GetActualInstance 

func (obj GetTopSearchesResponse) GetActualInstance() any

Get the actual instance.

func (GetTopSearchesResponse) MarshalJSON 

func (src GetTopSearchesResponse) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*GetTopSearchesResponse) UnmarshalJSON 

func (dst *GetTopSearchesResponse) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct.

type GetUsersCountResponse 

type GetUsersCountResponse struct {
	// Number of unique users.
	Count int32 `json:"count"`
	// Daily number of unique users.
	Dates []DailyUsers `json:"dates"`
}

GetUsersCountResponse struct for GetUsersCountResponse.

func NewEmptyGetUsersCountResponse 

func NewEmptyGetUsersCountResponse() *GetUsersCountResponse

NewEmptyGetUsersCountResponse return a pointer to an empty GetUsersCountResponse object.

func NewGetUsersCountResponse 

func NewGetUsersCountResponse(count int32, dates []DailyUsers) *GetUsersCountResponse

NewGetUsersCountResponse instantiates a new GetUsersCountResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetUsersCountResponse) GetCount 

func (o *GetUsersCountResponse) GetCount() int32

GetCount returns the Count field value.

func (*GetUsersCountResponse) GetCountOk 

func (o *GetUsersCountResponse) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*GetUsersCountResponse) GetDates 

func (o *GetUsersCountResponse) GetDates() []DailyUsers

GetDates returns the Dates field value.

func (*GetUsersCountResponse) GetDatesOk 

func (o *GetUsersCountResponse) GetDatesOk() ([]DailyUsers, bool)

GetDatesOk returns a tuple with the Dates field value and a boolean to check if the value has been set.

func (GetUsersCountResponse) MarshalJSON 

func (o GetUsersCountResponse) MarshalJSON() ([]byte, error)

func (*GetUsersCountResponse) SetCount 

func (o *GetUsersCountResponse) SetCount(v int32) *GetUsersCountResponse

SetCount sets field value.

func (*GetUsersCountResponse) SetDates 

func (o *GetUsersCountResponse) SetDates(v []DailyUsers) *GetUsersCountResponse

SetDates sets field value.

func (GetUsersCountResponse) String 

func (o GetUsersCountResponse) String() string

type Operator 

type Operator string

Operator Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator. 

const (
	OPERATOR_COLON                    Operator = ":"
	OPERATOR_LESS_THAN                Operator = "<"
	OPERATOR_LESS_THAN_OR_EQUAL_TO    Operator = "<="
	OPERATOR_EQUAL                    Operator = "="
	OPERATOR_NOT_EQUAL                Operator = "!="
	OPERATOR_GREATER_THAN             Operator = ">"
	OPERATOR_GREATER_THAN_OR_EQUAL_TO Operator = ">="
)

List of operator.

func NewOperatorFromValue 

func NewOperatorFromValue(v string) (*Operator, error)

NewOperatorFromValue returns a pointer to a valid Operator for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (Operator) IsValid 

func (v Operator) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (Operator) Ptr 

func (v Operator) Ptr() *Operator

Ptr returns reference to operator value.

func (*Operator) UnmarshalJSON 

func (v *Operator) UnmarshalJSON(src []byte) error

type OrderBy 

type OrderBy string

OrderBy Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. 

const (
	ORDER_BY_SEARCH_COUNT           OrderBy = "searchCount"
	ORDER_BY_CLICK_THROUGH_RATE     OrderBy = "clickThroughRate"
	ORDER_BY_CONVERSION_RATE        OrderBy = "conversionRate"
	ORDER_BY_AVERAGE_CLICK_POSITION OrderBy = "averageClickPosition"
)

List of orderBy.

func NewOrderByFromValue 

func NewOrderByFromValue(v string) (*OrderBy, error)

NewOrderByFromValue returns a pointer to a valid OrderBy for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (OrderBy) IsValid 

func (v OrderBy) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (OrderBy) Ptr 

func (v OrderBy) Ptr() *OrderBy

Ptr returns reference to orderBy value.

func (*OrderBy) UnmarshalJSON 

func (v *OrderBy) UnmarshalJSON(src []byte) error

type Region 

type Region string
const (
	DE Region = "de"
	US Region = "us"
)

type RequestOption 

type RequestOption interface {
	// contains filtered or unexported methods
}

type TopCountry 

type TopCountry struct {
	// Country code.
	Country string `json:"country"`
	// Number of occurrences.
	Count int32 `json:"count"`
}

TopCountry struct for TopCountry.

func NewEmptyTopCountry 

func NewEmptyTopCountry() *TopCountry

NewEmptyTopCountry return a pointer to an empty TopCountry object.

func NewTopCountry 

func NewTopCountry(country string, count int32) *TopCountry

NewTopCountry instantiates a new TopCountry object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopCountry) GetCount 

func (o *TopCountry) GetCount() int32

GetCount returns the Count field value.

func (*TopCountry) GetCountOk 

func (o *TopCountry) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*TopCountry) GetCountry 

func (o *TopCountry) GetCountry() string

GetCountry returns the Country field value.

func (*TopCountry) GetCountryOk 

func (o *TopCountry) GetCountryOk() (*string, bool)

GetCountryOk returns a tuple with the Country field value and a boolean to check if the value has been set.

func (TopCountry) MarshalJSON 

func (o TopCountry) MarshalJSON() ([]byte, error)

func (*TopCountry) SetCount 

func (o *TopCountry) SetCount(v int32) *TopCountry

SetCount sets field value.

func (*TopCountry) SetCountry 

func (o *TopCountry) SetCountry(v string) *TopCountry

SetCountry sets field value.

func (TopCountry) String 

func (o TopCountry) String() string

type TopHit 

type TopHit struct {
	// Object ID of a record that's returned as a search result.
	Hit string `json:"hit"`
	// Number of occurrences.
	Count int32 `json:"count"`
}

TopHit struct for TopHit.

func NewEmptyTopHit 

func NewEmptyTopHit() *TopHit

NewEmptyTopHit return a pointer to an empty TopHit object.

func NewTopHit 

func NewTopHit(hit string, count int32) *TopHit

NewTopHit instantiates a new TopHit object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopHit) GetCount 

func (o *TopHit) GetCount() int32

GetCount returns the Count field value.

func (*TopHit) GetCountOk 

func (o *TopHit) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*TopHit) GetHit 

func (o *TopHit) GetHit() string

GetHit returns the Hit field value.

func (*TopHit) GetHitOk 

func (o *TopHit) GetHitOk() (*string, bool)

GetHitOk returns a tuple with the Hit field value and a boolean to check if the value has been set.

func (TopHit) MarshalJSON 

func (o TopHit) MarshalJSON() ([]byte, error)

func (*TopHit) SetCount 

func (o *TopHit) SetCount(v int32) *TopHit

SetCount sets field value.

func (*TopHit) SetHit 

func (o *TopHit) SetHit(v string) *TopHit

SetHit sets field value.

func (TopHit) String 

func (o TopHit) String() string

type TopHitWithAnalytics 

type TopHitWithAnalytics struct {
	// Object ID of a record that's returned as a search result.
	Hit string `json:"hit"`
	// Number of occurrences.
	Count int32 `json:"count"`
	// Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	ClickThroughRate utils.Nullable[float64] `json:"clickThroughRate"`
	// Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	ConversionRate utils.Nullable[float64] `json:"conversionRate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedHitCount int32 `json:"trackedHitCount"`
	// Number of clicks associated with this search.
	ClickCount int32 `json:"clickCount"`
	// Number of conversions from this search.
	ConversionCount int32 `json:"conversionCount"`
}

TopHitWithAnalytics struct for TopHitWithAnalytics.

func NewEmptyTopHitWithAnalytics 

func NewEmptyTopHitWithAnalytics() *TopHitWithAnalytics

NewEmptyTopHitWithAnalytics return a pointer to an empty TopHitWithAnalytics object.

func NewTopHitWithAnalytics 

func NewTopHitWithAnalytics(hit string, count int32, clickThroughRate utils.Nullable[float64], conversionRate utils.Nullable[float64], trackedHitCount int32, clickCount int32, conversionCount int32) *TopHitWithAnalytics

NewTopHitWithAnalytics instantiates a new TopHitWithAnalytics object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopHitWithAnalytics) GetClickCount 

func (o *TopHitWithAnalytics) GetClickCount() int32

GetClickCount returns the ClickCount field value.

func (*TopHitWithAnalytics) GetClickCountOk 

func (o *TopHitWithAnalytics) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value and a boolean to check if the value has been set.

func (*TopHitWithAnalytics) GetClickThroughRate 

func (o *TopHitWithAnalytics) GetClickThroughRate() float64

GetClickThroughRate returns the ClickThroughRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopHitWithAnalytics) GetClickThroughRateOk 

func (o *TopHitWithAnalytics) GetClickThroughRateOk() (*float64, bool)

GetClickThroughRateOk returns a tuple with the ClickThroughRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopHitWithAnalytics) GetConversionCount 

func (o *TopHitWithAnalytics) GetConversionCount() int32

GetConversionCount returns the ConversionCount field value.

func (*TopHitWithAnalytics) GetConversionCountOk 

func (o *TopHitWithAnalytics) GetConversionCountOk() (*int32, bool)

GetConversionCountOk returns a tuple with the ConversionCount field value and a boolean to check if the value has been set.

func (*TopHitWithAnalytics) GetConversionRate 

func (o *TopHitWithAnalytics) GetConversionRate() float64

GetConversionRate returns the ConversionRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopHitWithAnalytics) GetConversionRateOk 

func (o *TopHitWithAnalytics) GetConversionRateOk() (*float64, bool)

GetConversionRateOk returns a tuple with the ConversionRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopHitWithAnalytics) GetCount 

func (o *TopHitWithAnalytics) GetCount() int32

GetCount returns the Count field value.

func (*TopHitWithAnalytics) GetCountOk 

func (o *TopHitWithAnalytics) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*TopHitWithAnalytics) GetHit 

func (o *TopHitWithAnalytics) GetHit() string

GetHit returns the Hit field value.

func (*TopHitWithAnalytics) GetHitOk 

func (o *TopHitWithAnalytics) GetHitOk() (*string, bool)

GetHitOk returns a tuple with the Hit field value and a boolean to check if the value has been set.

func (*TopHitWithAnalytics) GetTrackedHitCount 

func (o *TopHitWithAnalytics) GetTrackedHitCount() int32

GetTrackedHitCount returns the TrackedHitCount field value.

func (*TopHitWithAnalytics) GetTrackedHitCountOk 

func (o *TopHitWithAnalytics) GetTrackedHitCountOk() (*int32, bool)

GetTrackedHitCountOk returns a tuple with the TrackedHitCount field value and a boolean to check if the value has been set.

func (TopHitWithAnalytics) MarshalJSON 

func (o TopHitWithAnalytics) MarshalJSON() ([]byte, error)

func (*TopHitWithAnalytics) SetClickCount 

func (o *TopHitWithAnalytics) SetClickCount(v int32) *TopHitWithAnalytics

SetClickCount sets field value.

func (*TopHitWithAnalytics) SetClickThroughRate 

func (o *TopHitWithAnalytics) SetClickThroughRate(v float64) *TopHitWithAnalytics

SetClickThroughRate sets field value.

func (*TopHitWithAnalytics) SetConversionCount 

func (o *TopHitWithAnalytics) SetConversionCount(v int32) *TopHitWithAnalytics

SetConversionCount sets field value.

func (*TopHitWithAnalytics) SetConversionRate 

func (o *TopHitWithAnalytics) SetConversionRate(v float64) *TopHitWithAnalytics

SetConversionRate sets field value.

func (*TopHitWithAnalytics) SetCount 

func (o *TopHitWithAnalytics) SetCount(v int32) *TopHitWithAnalytics

SetCount sets field value.

func (*TopHitWithAnalytics) SetHit 

func (o *TopHitWithAnalytics) SetHit(v string) *TopHitWithAnalytics

SetHit sets field value.

func (*TopHitWithAnalytics) SetTrackedHitCount 

func (o *TopHitWithAnalytics) SetTrackedHitCount(v int32) *TopHitWithAnalytics

SetTrackedHitCount sets field value.

func (TopHitWithAnalytics) String 

func (o TopHitWithAnalytics) String() string

type TopHitWithRevenueAnalytics 

type TopHitWithRevenueAnalytics struct {
	// Object ID of a record that's returned as a search result.
	Hit string `json:"hit"`
	// Number of occurrences.
	Count int32 `json:"count"`
	// Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	ClickThroughRate utils.Nullable[float64] `json:"clickThroughRate"`
	// Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	ConversionRate utils.Nullable[float64] `json:"conversionRate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedHitCount int32 `json:"trackedHitCount"`
	// Number of clicks associated with this search.
	ClickCount int32 `json:"clickCount"`
	// Number of conversions from this search.
	ConversionCount int32 `json:"conversionCount"`
	// Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	AddToCartRate utils.Nullable[float64] `json:"addToCartRate"`
	// Number of add-to-cart events from this search.
	AddToCartCount int32 `json:"addToCartCount"`
	// Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	PurchaseRate utils.Nullable[float64] `json:"purchaseRate"`
	// Number of purchase events from this search.
	PurchaseCount int32 `json:"purchaseCount"`
	// Revenue associated with this search, broken-down by currencies.
	Currencies map[string]CurrencyCode `json:"currencies"`
}

TopHitWithRevenueAnalytics struct for TopHitWithRevenueAnalytics.

func NewEmptyTopHitWithRevenueAnalytics 

func NewEmptyTopHitWithRevenueAnalytics() *TopHitWithRevenueAnalytics

NewEmptyTopHitWithRevenueAnalytics return a pointer to an empty TopHitWithRevenueAnalytics object.

func NewTopHitWithRevenueAnalytics 

func NewTopHitWithRevenueAnalytics(hit string, count int32, clickThroughRate utils.Nullable[float64], conversionRate utils.Nullable[float64], trackedHitCount int32, clickCount int32, conversionCount int32, addToCartRate utils.Nullable[float64], addToCartCount int32, purchaseRate utils.Nullable[float64], purchaseCount int32, currencies map[string]CurrencyCode) *TopHitWithRevenueAnalytics

NewTopHitWithRevenueAnalytics instantiates a new TopHitWithRevenueAnalytics object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopHitWithRevenueAnalytics) GetAddToCartCount 

func (o *TopHitWithRevenueAnalytics) GetAddToCartCount() int32

GetAddToCartCount returns the AddToCartCount field value.

func (*TopHitWithRevenueAnalytics) GetAddToCartCountOk 

func (o *TopHitWithRevenueAnalytics) GetAddToCartCountOk() (*int32, bool)

GetAddToCartCountOk returns a tuple with the AddToCartCount field value and a boolean to check if the value has been set.

func (*TopHitWithRevenueAnalytics) GetAddToCartRate 

func (o *TopHitWithRevenueAnalytics) GetAddToCartRate() float64

GetAddToCartRate returns the AddToCartRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopHitWithRevenueAnalytics) GetAddToCartRateOk 

func (o *TopHitWithRevenueAnalytics) GetAddToCartRateOk() (*float64, bool)

GetAddToCartRateOk returns a tuple with the AddToCartRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopHitWithRevenueAnalytics) GetClickCount 

func (o *TopHitWithRevenueAnalytics) GetClickCount() int32

GetClickCount returns the ClickCount field value.

func (*TopHitWithRevenueAnalytics) GetClickCountOk 

func (o *TopHitWithRevenueAnalytics) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value and a boolean to check if the value has been set.

func (*TopHitWithRevenueAnalytics) GetClickThroughRate 

func (o *TopHitWithRevenueAnalytics) GetClickThroughRate() float64

GetClickThroughRate returns the ClickThroughRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopHitWithRevenueAnalytics) GetClickThroughRateOk 

func (o *TopHitWithRevenueAnalytics) GetClickThroughRateOk() (*float64, bool)

GetClickThroughRateOk returns a tuple with the ClickThroughRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopHitWithRevenueAnalytics) GetConversionCount 

func (o *TopHitWithRevenueAnalytics) GetConversionCount() int32

GetConversionCount returns the ConversionCount field value.

func (*TopHitWithRevenueAnalytics) GetConversionCountOk 

func (o *TopHitWithRevenueAnalytics) GetConversionCountOk() (*int32, bool)

GetConversionCountOk returns a tuple with the ConversionCount field value and a boolean to check if the value has been set.

func (*TopHitWithRevenueAnalytics) GetConversionRate 

func (o *TopHitWithRevenueAnalytics) GetConversionRate() float64

GetConversionRate returns the ConversionRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopHitWithRevenueAnalytics) GetConversionRateOk 

func (o *TopHitWithRevenueAnalytics) GetConversionRateOk() (*float64, bool)

GetConversionRateOk returns a tuple with the ConversionRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopHitWithRevenueAnalytics) GetCount 

func (o *TopHitWithRevenueAnalytics) GetCount() int32

GetCount returns the Count field value.

func (*TopHitWithRevenueAnalytics) GetCountOk 

func (o *TopHitWithRevenueAnalytics) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*TopHitWithRevenueAnalytics) GetCurrencies 

func (o *TopHitWithRevenueAnalytics) GetCurrencies() map[string]CurrencyCode

GetCurrencies returns the Currencies field value.

func (*TopHitWithRevenueAnalytics) GetCurrenciesOk 

func (o *TopHitWithRevenueAnalytics) GetCurrenciesOk() (*map[string]CurrencyCode, bool)

GetCurrenciesOk returns a tuple with the Currencies field value and a boolean to check if the value has been set.

func (*TopHitWithRevenueAnalytics) GetHit 

func (o *TopHitWithRevenueAnalytics) GetHit() string

GetHit returns the Hit field value.

func (*TopHitWithRevenueAnalytics) GetHitOk 

func (o *TopHitWithRevenueAnalytics) GetHitOk() (*string, bool)

GetHitOk returns a tuple with the Hit field value and a boolean to check if the value has been set.

func (*TopHitWithRevenueAnalytics) GetPurchaseCount 

func (o *TopHitWithRevenueAnalytics) GetPurchaseCount() int32

GetPurchaseCount returns the PurchaseCount field value.

func (*TopHitWithRevenueAnalytics) GetPurchaseCountOk 

func (o *TopHitWithRevenueAnalytics) GetPurchaseCountOk() (*int32, bool)

GetPurchaseCountOk returns a tuple with the PurchaseCount field value and a boolean to check if the value has been set.

func (*TopHitWithRevenueAnalytics) GetPurchaseRate 

func (o *TopHitWithRevenueAnalytics) GetPurchaseRate() float64

GetPurchaseRate returns the PurchaseRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopHitWithRevenueAnalytics) GetPurchaseRateOk 

func (o *TopHitWithRevenueAnalytics) GetPurchaseRateOk() (*float64, bool)

GetPurchaseRateOk returns a tuple with the PurchaseRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopHitWithRevenueAnalytics) GetTrackedHitCount 

func (o *TopHitWithRevenueAnalytics) GetTrackedHitCount() int32

GetTrackedHitCount returns the TrackedHitCount field value.

func (*TopHitWithRevenueAnalytics) GetTrackedHitCountOk 

func (o *TopHitWithRevenueAnalytics) GetTrackedHitCountOk() (*int32, bool)

GetTrackedHitCountOk returns a tuple with the TrackedHitCount field value and a boolean to check if the value has been set.

func (TopHitWithRevenueAnalytics) MarshalJSON 

func (o TopHitWithRevenueAnalytics) MarshalJSON() ([]byte, error)

func (*TopHitWithRevenueAnalytics) SetAddToCartCount 

func (o *TopHitWithRevenueAnalytics) SetAddToCartCount(v int32) *TopHitWithRevenueAnalytics

SetAddToCartCount sets field value.

func (*TopHitWithRevenueAnalytics) SetAddToCartRate 

func (o *TopHitWithRevenueAnalytics) SetAddToCartRate(v float64) *TopHitWithRevenueAnalytics

SetAddToCartRate sets field value.

func (*TopHitWithRevenueAnalytics) SetClickCount 

func (o *TopHitWithRevenueAnalytics) SetClickCount(v int32) *TopHitWithRevenueAnalytics

SetClickCount sets field value.

func (*TopHitWithRevenueAnalytics) SetClickThroughRate 

func (o *TopHitWithRevenueAnalytics) SetClickThroughRate(v float64) *TopHitWithRevenueAnalytics

SetClickThroughRate sets field value.

func (*TopHitWithRevenueAnalytics) SetConversionCount 

func (o *TopHitWithRevenueAnalytics) SetConversionCount(v int32) *TopHitWithRevenueAnalytics

SetConversionCount sets field value.

func (*TopHitWithRevenueAnalytics) SetConversionRate 

func (o *TopHitWithRevenueAnalytics) SetConversionRate(v float64) *TopHitWithRevenueAnalytics

SetConversionRate sets field value.

func (*TopHitWithRevenueAnalytics) SetCount 

func (o *TopHitWithRevenueAnalytics) SetCount(v int32) *TopHitWithRevenueAnalytics

SetCount sets field value.

func (*TopHitWithRevenueAnalytics) SetCurrencies 

func (o *TopHitWithRevenueAnalytics) SetCurrencies(v map[string]CurrencyCode) *TopHitWithRevenueAnalytics

SetCurrencies sets field value.

func (*TopHitWithRevenueAnalytics) SetHit 

func (o *TopHitWithRevenueAnalytics) SetHit(v string) *TopHitWithRevenueAnalytics

SetHit sets field value.

func (*TopHitWithRevenueAnalytics) SetPurchaseCount 

func (o *TopHitWithRevenueAnalytics) SetPurchaseCount(v int32) *TopHitWithRevenueAnalytics

SetPurchaseCount sets field value.

func (*TopHitWithRevenueAnalytics) SetPurchaseRate 

func (o *TopHitWithRevenueAnalytics) SetPurchaseRate(v float64) *TopHitWithRevenueAnalytics

SetPurchaseRate sets field value.

func (*TopHitWithRevenueAnalytics) SetTrackedHitCount 

func (o *TopHitWithRevenueAnalytics) SetTrackedHitCount(v int32) *TopHitWithRevenueAnalytics

SetTrackedHitCount sets field value.

func (TopHitWithRevenueAnalytics) String 

func (o TopHitWithRevenueAnalytics) String() string

type TopHitsResponse 

type TopHitsResponse struct {
	// Most frequent search results.
	Hits []TopHit `json:"hits"`
}

TopHitsResponse struct for TopHitsResponse.

func NewEmptyTopHitsResponse 

func NewEmptyTopHitsResponse() *TopHitsResponse

NewEmptyTopHitsResponse return a pointer to an empty TopHitsResponse object.

func NewTopHitsResponse 

func NewTopHitsResponse(hits []TopHit) *TopHitsResponse

NewTopHitsResponse instantiates a new TopHitsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopHitsResponse) GetHits 

func (o *TopHitsResponse) GetHits() []TopHit

GetHits returns the Hits field value.

func (*TopHitsResponse) GetHitsOk 

func (o *TopHitsResponse) GetHitsOk() ([]TopHit, bool)

GetHitsOk returns a tuple with the Hits field value and a boolean to check if the value has been set.

func (TopHitsResponse) MarshalJSON 

func (o TopHitsResponse) MarshalJSON() ([]byte, error)

func (*TopHitsResponse) SetHits 

func (o *TopHitsResponse) SetHits(v []TopHit) *TopHitsResponse

SetHits sets field value.

func (TopHitsResponse) String 

func (o TopHitsResponse) String() string

type TopHitsResponseWithAnalytics 

type TopHitsResponseWithAnalytics struct {
	// Most frequent search results with click and conversion metrics.
	Hits []TopHitWithAnalytics `json:"hits"`
}

TopHitsResponseWithAnalytics struct for TopHitsResponseWithAnalytics.

func NewEmptyTopHitsResponseWithAnalytics 

func NewEmptyTopHitsResponseWithAnalytics() *TopHitsResponseWithAnalytics

NewEmptyTopHitsResponseWithAnalytics return a pointer to an empty TopHitsResponseWithAnalytics object.

func NewTopHitsResponseWithAnalytics 

func NewTopHitsResponseWithAnalytics(hits []TopHitWithAnalytics) *TopHitsResponseWithAnalytics

NewTopHitsResponseWithAnalytics instantiates a new TopHitsResponseWithAnalytics object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopHitsResponseWithAnalytics) GetHits 

func (o *TopHitsResponseWithAnalytics) GetHits() []TopHitWithAnalytics

GetHits returns the Hits field value.

func (*TopHitsResponseWithAnalytics) GetHitsOk 

func (o *TopHitsResponseWithAnalytics) GetHitsOk() ([]TopHitWithAnalytics, bool)

GetHitsOk returns a tuple with the Hits field value and a boolean to check if the value has been set.

func (TopHitsResponseWithAnalytics) MarshalJSON 

func (o TopHitsResponseWithAnalytics) MarshalJSON() ([]byte, error)

func (*TopHitsResponseWithAnalytics) SetHits 

func (o *TopHitsResponseWithAnalytics) SetHits(v []TopHitWithAnalytics) *TopHitsResponseWithAnalytics

SetHits sets field value.

func (TopHitsResponseWithAnalytics) String 

func (o TopHitsResponseWithAnalytics) String() string

type TopHitsResponseWithRevenueAnalytics 

type TopHitsResponseWithRevenueAnalytics struct {
	// Most frequent search results with click, conversion, and revenue metrics.
	Hits []TopHitWithRevenueAnalytics `json:"hits"`
}

TopHitsResponseWithRevenueAnalytics struct for TopHitsResponseWithRevenueAnalytics.

func NewEmptyTopHitsResponseWithRevenueAnalytics 

func NewEmptyTopHitsResponseWithRevenueAnalytics() *TopHitsResponseWithRevenueAnalytics

NewEmptyTopHitsResponseWithRevenueAnalytics return a pointer to an empty TopHitsResponseWithRevenueAnalytics object.

func NewTopHitsResponseWithRevenueAnalytics 

func NewTopHitsResponseWithRevenueAnalytics(hits []TopHitWithRevenueAnalytics) *TopHitsResponseWithRevenueAnalytics

NewTopHitsResponseWithRevenueAnalytics instantiates a new TopHitsResponseWithRevenueAnalytics object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopHitsResponseWithRevenueAnalytics) GetHits 

func (o *TopHitsResponseWithRevenueAnalytics) GetHits() []TopHitWithRevenueAnalytics

GetHits returns the Hits field value.

func (*TopHitsResponseWithRevenueAnalytics) GetHitsOk 

func (o *TopHitsResponseWithRevenueAnalytics) GetHitsOk() ([]TopHitWithRevenueAnalytics, bool)

GetHitsOk returns a tuple with the Hits field value and a boolean to check if the value has been set.

func (TopHitsResponseWithRevenueAnalytics) MarshalJSON 

func (o TopHitsResponseWithRevenueAnalytics) MarshalJSON() ([]byte, error)

func (*TopHitsResponseWithRevenueAnalytics) SetHits 

func (o *TopHitsResponseWithRevenueAnalytics) SetHits(v []TopHitWithRevenueAnalytics) *TopHitsResponseWithRevenueAnalytics

SetHits sets field value.

func (TopHitsResponseWithRevenueAnalytics) String 

func (o TopHitsResponseWithRevenueAnalytics) String() string

type TopSearch 

type TopSearch struct {
	// Search query.
	Search string `json:"search"`
	// Number of searches.
	Count int32 `json:"count"`
	// Number of results (hits).
	NbHits int32 `json:"nbHits"`
}

TopSearch struct for TopSearch.

func NewEmptyTopSearch 

func NewEmptyTopSearch() *TopSearch

NewEmptyTopSearch return a pointer to an empty TopSearch object.

func NewTopSearch 

func NewTopSearch(search string, count int32, nbHits int32) *TopSearch

NewTopSearch instantiates a new TopSearch object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopSearch) GetCount 

func (o *TopSearch) GetCount() int32

GetCount returns the Count field value.

func (*TopSearch) GetCountOk 

func (o *TopSearch) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*TopSearch) GetNbHits 

func (o *TopSearch) GetNbHits() int32

GetNbHits returns the NbHits field value.

func (*TopSearch) GetNbHitsOk 

func (o *TopSearch) GetNbHitsOk() (*int32, bool)

GetNbHitsOk returns a tuple with the NbHits field value and a boolean to check if the value has been set.

func (*TopSearch) GetSearch 

func (o *TopSearch) GetSearch() string

GetSearch returns the Search field value.

func (*TopSearch) GetSearchOk 

func (o *TopSearch) GetSearchOk() (*string, bool)

GetSearchOk returns a tuple with the Search field value and a boolean to check if the value has been set.

func (TopSearch) MarshalJSON 

func (o TopSearch) MarshalJSON() ([]byte, error)

func (*TopSearch) SetCount 

func (o *TopSearch) SetCount(v int32) *TopSearch

SetCount sets field value.

func (*TopSearch) SetNbHits 

func (o *TopSearch) SetNbHits(v int32) *TopSearch

SetNbHits sets field value.

func (*TopSearch) SetSearch 

func (o *TopSearch) SetSearch(v string) *TopSearch

SetSearch sets field value.

func (TopSearch) String 

func (o TopSearch) String() string

type TopSearchWithAnalytics 

type TopSearchWithAnalytics struct {
	// Search query.
	Search string `json:"search"`
	// Number of searches.
	Count int32 `json:"count"`
	// Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	ClickThroughRate utils.Nullable[float64] `json:"clickThroughRate"`
	// Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	AverageClickPosition utils.Nullable[float64] `json:"averageClickPosition"`
	// List of positions in the search results and clicks associated with this search.
	ClickPositions []ClickPosition `json:"clickPositions"`
	// Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	ConversionRate utils.Nullable[float64] `json:"conversionRate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Number of clicks associated with this search.
	ClickCount int32 `json:"clickCount"`
	// Number of conversions from this search.
	ConversionCount int32 `json:"conversionCount"`
	// Number of results (hits).
	NbHits int32 `json:"nbHits"`
}

TopSearchWithAnalytics struct for TopSearchWithAnalytics.

func NewEmptyTopSearchWithAnalytics 

func NewEmptyTopSearchWithAnalytics() *TopSearchWithAnalytics

NewEmptyTopSearchWithAnalytics return a pointer to an empty TopSearchWithAnalytics object.

func NewTopSearchWithAnalytics 

func NewTopSearchWithAnalytics(search string, count int32, clickThroughRate utils.Nullable[float64], averageClickPosition utils.Nullable[float64], clickPositions []ClickPosition, conversionRate utils.Nullable[float64], trackedSearchCount int32, clickCount int32, conversionCount int32, nbHits int32) *TopSearchWithAnalytics

NewTopSearchWithAnalytics instantiates a new TopSearchWithAnalytics object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopSearchWithAnalytics) GetAverageClickPosition 

func (o *TopSearchWithAnalytics) GetAverageClickPosition() float64

GetAverageClickPosition returns the AverageClickPosition field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopSearchWithAnalytics) GetAverageClickPositionOk 

func (o *TopSearchWithAnalytics) GetAverageClickPositionOk() (*float64, bool)

GetAverageClickPositionOk returns a tuple with the AverageClickPosition field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopSearchWithAnalytics) GetClickCount 

func (o *TopSearchWithAnalytics) GetClickCount() int32

GetClickCount returns the ClickCount field value.

func (*TopSearchWithAnalytics) GetClickCountOk 

func (o *TopSearchWithAnalytics) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value and a boolean to check if the value has been set.

func (*TopSearchWithAnalytics) GetClickPositions 

func (o *TopSearchWithAnalytics) GetClickPositions() []ClickPosition

GetClickPositions returns the ClickPositions field value.

func (*TopSearchWithAnalytics) GetClickPositionsOk 

func (o *TopSearchWithAnalytics) GetClickPositionsOk() ([]ClickPosition, bool)

GetClickPositionsOk returns a tuple with the ClickPositions field value and a boolean to check if the value has been set.

func (*TopSearchWithAnalytics) GetClickThroughRate 

func (o *TopSearchWithAnalytics) GetClickThroughRate() float64

GetClickThroughRate returns the ClickThroughRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopSearchWithAnalytics) GetClickThroughRateOk 

func (o *TopSearchWithAnalytics) GetClickThroughRateOk() (*float64, bool)

GetClickThroughRateOk returns a tuple with the ClickThroughRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopSearchWithAnalytics) GetConversionCount 

func (o *TopSearchWithAnalytics) GetConversionCount() int32

GetConversionCount returns the ConversionCount field value.

func (*TopSearchWithAnalytics) GetConversionCountOk 

func (o *TopSearchWithAnalytics) GetConversionCountOk() (*int32, bool)

GetConversionCountOk returns a tuple with the ConversionCount field value and a boolean to check if the value has been set.

func (*TopSearchWithAnalytics) GetConversionRate 

func (o *TopSearchWithAnalytics) GetConversionRate() float64

GetConversionRate returns the ConversionRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopSearchWithAnalytics) GetConversionRateOk 

func (o *TopSearchWithAnalytics) GetConversionRateOk() (*float64, bool)

GetConversionRateOk returns a tuple with the ConversionRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopSearchWithAnalytics) GetCount 

func (o *TopSearchWithAnalytics) GetCount() int32

GetCount returns the Count field value.

func (*TopSearchWithAnalytics) GetCountOk 

func (o *TopSearchWithAnalytics) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*TopSearchWithAnalytics) GetNbHits 

func (o *TopSearchWithAnalytics) GetNbHits() int32

GetNbHits returns the NbHits field value.

func (*TopSearchWithAnalytics) GetNbHitsOk 

func (o *TopSearchWithAnalytics) GetNbHitsOk() (*int32, bool)

GetNbHitsOk returns a tuple with the NbHits field value and a boolean to check if the value has been set.

func (*TopSearchWithAnalytics) GetSearch 

func (o *TopSearchWithAnalytics) GetSearch() string

GetSearch returns the Search field value.

func (*TopSearchWithAnalytics) GetSearchOk 

func (o *TopSearchWithAnalytics) GetSearchOk() (*string, bool)

GetSearchOk returns a tuple with the Search field value and a boolean to check if the value has been set.

func (*TopSearchWithAnalytics) GetTrackedSearchCount 

func (o *TopSearchWithAnalytics) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*TopSearchWithAnalytics) GetTrackedSearchCountOk 

func (o *TopSearchWithAnalytics) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (TopSearchWithAnalytics) MarshalJSON 

func (o TopSearchWithAnalytics) MarshalJSON() ([]byte, error)

func (*TopSearchWithAnalytics) SetAverageClickPosition 

func (o *TopSearchWithAnalytics) SetAverageClickPosition(v float64) *TopSearchWithAnalytics

SetAverageClickPosition sets field value.

func (*TopSearchWithAnalytics) SetClickCount 

func (o *TopSearchWithAnalytics) SetClickCount(v int32) *TopSearchWithAnalytics

SetClickCount sets field value.

func (*TopSearchWithAnalytics) SetClickPositions 

func (o *TopSearchWithAnalytics) SetClickPositions(v []ClickPosition) *TopSearchWithAnalytics

SetClickPositions sets field value.

func (*TopSearchWithAnalytics) SetClickThroughRate 

func (o *TopSearchWithAnalytics) SetClickThroughRate(v float64) *TopSearchWithAnalytics

SetClickThroughRate sets field value.

func (*TopSearchWithAnalytics) SetConversionCount 

func (o *TopSearchWithAnalytics) SetConversionCount(v int32) *TopSearchWithAnalytics

SetConversionCount sets field value.

func (*TopSearchWithAnalytics) SetConversionRate 

func (o *TopSearchWithAnalytics) SetConversionRate(v float64) *TopSearchWithAnalytics

SetConversionRate sets field value.

func (*TopSearchWithAnalytics) SetCount 

func (o *TopSearchWithAnalytics) SetCount(v int32) *TopSearchWithAnalytics

SetCount sets field value.

func (*TopSearchWithAnalytics) SetNbHits 

func (o *TopSearchWithAnalytics) SetNbHits(v int32) *TopSearchWithAnalytics

SetNbHits sets field value.

func (*TopSearchWithAnalytics) SetSearch 

func (o *TopSearchWithAnalytics) SetSearch(v string) *TopSearchWithAnalytics

SetSearch sets field value.

func (*TopSearchWithAnalytics) SetTrackedSearchCount 

func (o *TopSearchWithAnalytics) SetTrackedSearchCount(v int32) *TopSearchWithAnalytics

SetTrackedSearchCount sets field value.

func (TopSearchWithAnalytics) String 

func (o TopSearchWithAnalytics) String() string

type TopSearchWithRevenueAnalytics 

type TopSearchWithRevenueAnalytics struct {
	// Search query.
	Search string `json:"search"`
	// Number of searches.
	Count int32 `json:"count"`
	// Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	ClickThroughRate utils.Nullable[float64] `json:"clickThroughRate"`
	// Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	AverageClickPosition utils.Nullable[float64] `json:"averageClickPosition"`
	// List of positions in the search results and clicks associated with this search.
	ClickPositions []ClickPosition `json:"clickPositions"`
	// Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	ConversionRate utils.Nullable[float64] `json:"conversionRate"`
	// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
	TrackedSearchCount int32 `json:"trackedSearchCount"`
	// Number of clicks associated with this search.
	ClickCount int32 `json:"clickCount"`
	// Number of conversions from this search.
	ConversionCount int32 `json:"conversionCount"`
	// Number of results (hits).
	NbHits int32 `json:"nbHits"`
	// Revenue associated with this search, broken-down by currencies.
	Currencies map[string]CurrencyCode `json:"currencies"`
	// Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	AddToCartRate utils.Nullable[float64] `json:"addToCartRate"`
	// Number of add-to-cart events from this search.
	AddToCartCount int32 `json:"addToCartCount"`
	// Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
	PurchaseRate utils.Nullable[float64] `json:"purchaseRate"`
	// Number of purchase events from this search.
	PurchaseCount int32 `json:"purchaseCount"`
}

TopSearchWithRevenueAnalytics struct for TopSearchWithRevenueAnalytics.

func NewEmptyTopSearchWithRevenueAnalytics 

func NewEmptyTopSearchWithRevenueAnalytics() *TopSearchWithRevenueAnalytics

NewEmptyTopSearchWithRevenueAnalytics return a pointer to an empty TopSearchWithRevenueAnalytics object.

func NewTopSearchWithRevenueAnalytics 

func NewTopSearchWithRevenueAnalytics(search string, count int32, clickThroughRate utils.Nullable[float64], averageClickPosition utils.Nullable[float64], clickPositions []ClickPosition, conversionRate utils.Nullable[float64], trackedSearchCount int32, clickCount int32, conversionCount int32, nbHits int32, currencies map[string]CurrencyCode, addToCartRate utils.Nullable[float64], addToCartCount int32, purchaseRate utils.Nullable[float64], purchaseCount int32) *TopSearchWithRevenueAnalytics

NewTopSearchWithRevenueAnalytics instantiates a new TopSearchWithRevenueAnalytics object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopSearchWithRevenueAnalytics) GetAddToCartCount 

func (o *TopSearchWithRevenueAnalytics) GetAddToCartCount() int32

GetAddToCartCount returns the AddToCartCount field value.

func (*TopSearchWithRevenueAnalytics) GetAddToCartCountOk 

func (o *TopSearchWithRevenueAnalytics) GetAddToCartCountOk() (*int32, bool)

GetAddToCartCountOk returns a tuple with the AddToCartCount field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetAddToCartRate 

func (o *TopSearchWithRevenueAnalytics) GetAddToCartRate() float64

GetAddToCartRate returns the AddToCartRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopSearchWithRevenueAnalytics) GetAddToCartRateOk 

func (o *TopSearchWithRevenueAnalytics) GetAddToCartRateOk() (*float64, bool)

GetAddToCartRateOk returns a tuple with the AddToCartRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopSearchWithRevenueAnalytics) GetAverageClickPosition 

func (o *TopSearchWithRevenueAnalytics) GetAverageClickPosition() float64

GetAverageClickPosition returns the AverageClickPosition field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopSearchWithRevenueAnalytics) GetAverageClickPositionOk 

func (o *TopSearchWithRevenueAnalytics) GetAverageClickPositionOk() (*float64, bool)

GetAverageClickPositionOk returns a tuple with the AverageClickPosition field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopSearchWithRevenueAnalytics) GetClickCount 

func (o *TopSearchWithRevenueAnalytics) GetClickCount() int32

GetClickCount returns the ClickCount field value.

func (*TopSearchWithRevenueAnalytics) GetClickCountOk 

func (o *TopSearchWithRevenueAnalytics) GetClickCountOk() (*int32, bool)

GetClickCountOk returns a tuple with the ClickCount field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetClickPositions 

func (o *TopSearchWithRevenueAnalytics) GetClickPositions() []ClickPosition

GetClickPositions returns the ClickPositions field value.

func (*TopSearchWithRevenueAnalytics) GetClickPositionsOk 

func (o *TopSearchWithRevenueAnalytics) GetClickPositionsOk() ([]ClickPosition, bool)

GetClickPositionsOk returns a tuple with the ClickPositions field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetClickThroughRate 

func (o *TopSearchWithRevenueAnalytics) GetClickThroughRate() float64

GetClickThroughRate returns the ClickThroughRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopSearchWithRevenueAnalytics) GetClickThroughRateOk 

func (o *TopSearchWithRevenueAnalytics) GetClickThroughRateOk() (*float64, bool)

GetClickThroughRateOk returns a tuple with the ClickThroughRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopSearchWithRevenueAnalytics) GetConversionCount 

func (o *TopSearchWithRevenueAnalytics) GetConversionCount() int32

GetConversionCount returns the ConversionCount field value.

func (*TopSearchWithRevenueAnalytics) GetConversionCountOk 

func (o *TopSearchWithRevenueAnalytics) GetConversionCountOk() (*int32, bool)

GetConversionCountOk returns a tuple with the ConversionCount field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetConversionRate 

func (o *TopSearchWithRevenueAnalytics) GetConversionRate() float64

GetConversionRate returns the ConversionRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopSearchWithRevenueAnalytics) GetConversionRateOk 

func (o *TopSearchWithRevenueAnalytics) GetConversionRateOk() (*float64, bool)

GetConversionRateOk returns a tuple with the ConversionRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopSearchWithRevenueAnalytics) GetCount 

func (o *TopSearchWithRevenueAnalytics) GetCount() int32

GetCount returns the Count field value.

func (*TopSearchWithRevenueAnalytics) GetCountOk 

func (o *TopSearchWithRevenueAnalytics) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetCurrencies 

func (o *TopSearchWithRevenueAnalytics) GetCurrencies() map[string]CurrencyCode

GetCurrencies returns the Currencies field value.

func (*TopSearchWithRevenueAnalytics) GetCurrenciesOk 

func (o *TopSearchWithRevenueAnalytics) GetCurrenciesOk() (*map[string]CurrencyCode, bool)

GetCurrenciesOk returns a tuple with the Currencies field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetNbHits 

func (o *TopSearchWithRevenueAnalytics) GetNbHits() int32

GetNbHits returns the NbHits field value.

func (*TopSearchWithRevenueAnalytics) GetNbHitsOk 

func (o *TopSearchWithRevenueAnalytics) GetNbHitsOk() (*int32, bool)

GetNbHitsOk returns a tuple with the NbHits field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetPurchaseCount 

func (o *TopSearchWithRevenueAnalytics) GetPurchaseCount() int32

GetPurchaseCount returns the PurchaseCount field value.

func (*TopSearchWithRevenueAnalytics) GetPurchaseCountOk 

func (o *TopSearchWithRevenueAnalytics) GetPurchaseCountOk() (*int32, bool)

GetPurchaseCountOk returns a tuple with the PurchaseCount field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetPurchaseRate 

func (o *TopSearchWithRevenueAnalytics) GetPurchaseRate() float64

GetPurchaseRate returns the PurchaseRate field value. If the value is explicit nil, the zero value for float64 will be returned.

func (*TopSearchWithRevenueAnalytics) GetPurchaseRateOk 

func (o *TopSearchWithRevenueAnalytics) GetPurchaseRateOk() (*float64, bool)

GetPurchaseRateOk returns a tuple with the PurchaseRate field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*TopSearchWithRevenueAnalytics) GetSearch 

func (o *TopSearchWithRevenueAnalytics) GetSearch() string

GetSearch returns the Search field value.

func (*TopSearchWithRevenueAnalytics) GetSearchOk 

func (o *TopSearchWithRevenueAnalytics) GetSearchOk() (*string, bool)

GetSearchOk returns a tuple with the Search field value and a boolean to check if the value has been set.

func (*TopSearchWithRevenueAnalytics) GetTrackedSearchCount 

func (o *TopSearchWithRevenueAnalytics) GetTrackedSearchCount() int32

GetTrackedSearchCount returns the TrackedSearchCount field value.

func (*TopSearchWithRevenueAnalytics) GetTrackedSearchCountOk 

func (o *TopSearchWithRevenueAnalytics) GetTrackedSearchCountOk() (*int32, bool)

GetTrackedSearchCountOk returns a tuple with the TrackedSearchCount field value and a boolean to check if the value has been set.

func (TopSearchWithRevenueAnalytics) MarshalJSON 

func (o TopSearchWithRevenueAnalytics) MarshalJSON() ([]byte, error)

func (*TopSearchWithRevenueAnalytics) SetAddToCartCount 

func (o *TopSearchWithRevenueAnalytics) SetAddToCartCount(v int32) *TopSearchWithRevenueAnalytics

SetAddToCartCount sets field value.

func (*TopSearchWithRevenueAnalytics) SetAddToCartRate 

func (o *TopSearchWithRevenueAnalytics) SetAddToCartRate(v float64) *TopSearchWithRevenueAnalytics

SetAddToCartRate sets field value.

func (*TopSearchWithRevenueAnalytics) SetAverageClickPosition 

func (o *TopSearchWithRevenueAnalytics) SetAverageClickPosition(v float64) *TopSearchWithRevenueAnalytics

SetAverageClickPosition sets field value.

func (*TopSearchWithRevenueAnalytics) SetClickCount 

func (o *TopSearchWithRevenueAnalytics) SetClickCount(v int32) *TopSearchWithRevenueAnalytics

SetClickCount sets field value.

func (*TopSearchWithRevenueAnalytics) SetClickPositions 

func (o *TopSearchWithRevenueAnalytics) SetClickPositions(v []ClickPosition) *TopSearchWithRevenueAnalytics

SetClickPositions sets field value.

func (*TopSearchWithRevenueAnalytics) SetClickThroughRate 

func (o *TopSearchWithRevenueAnalytics) SetClickThroughRate(v float64) *TopSearchWithRevenueAnalytics

SetClickThroughRate sets field value.

func (*TopSearchWithRevenueAnalytics) SetConversionCount 

func (o *TopSearchWithRevenueAnalytics) SetConversionCount(v int32) *TopSearchWithRevenueAnalytics

SetConversionCount sets field value.

func (*TopSearchWithRevenueAnalytics) SetConversionRate 

func (o *TopSearchWithRevenueAnalytics) SetConversionRate(v float64) *TopSearchWithRevenueAnalytics

SetConversionRate sets field value.

func (*TopSearchWithRevenueAnalytics) SetCount 

func (o *TopSearchWithRevenueAnalytics) SetCount(v int32) *TopSearchWithRevenueAnalytics

SetCount sets field value.

func (*TopSearchWithRevenueAnalytics) SetCurrencies 

func (o *TopSearchWithRevenueAnalytics) SetCurrencies(v map[string]CurrencyCode) *TopSearchWithRevenueAnalytics

SetCurrencies sets field value.

func (*TopSearchWithRevenueAnalytics) SetNbHits 

func (o *TopSearchWithRevenueAnalytics) SetNbHits(v int32) *TopSearchWithRevenueAnalytics

SetNbHits sets field value.

func (*TopSearchWithRevenueAnalytics) SetPurchaseCount 

func (o *TopSearchWithRevenueAnalytics) SetPurchaseCount(v int32) *TopSearchWithRevenueAnalytics

SetPurchaseCount sets field value.

func (*TopSearchWithRevenueAnalytics) SetPurchaseRate 

func (o *TopSearchWithRevenueAnalytics) SetPurchaseRate(v float64) *TopSearchWithRevenueAnalytics

SetPurchaseRate sets field value.

func (*TopSearchWithRevenueAnalytics) SetSearch 

func (o *TopSearchWithRevenueAnalytics) SetSearch(v string) *TopSearchWithRevenueAnalytics

SetSearch sets field value.

func (*TopSearchWithRevenueAnalytics) SetTrackedSearchCount 

func (o *TopSearchWithRevenueAnalytics) SetTrackedSearchCount(v int32) *TopSearchWithRevenueAnalytics

SetTrackedSearchCount sets field value.

func (TopSearchWithRevenueAnalytics) String 

func (o TopSearchWithRevenueAnalytics) String() string

type TopSearchesResponse 

type TopSearchesResponse struct {
	// Most popular searches and their number of search results (hits).
	Searches []TopSearch `json:"searches"`
}

TopSearchesResponse struct for TopSearchesResponse.

func NewEmptyTopSearchesResponse 

func NewEmptyTopSearchesResponse() *TopSearchesResponse

NewEmptyTopSearchesResponse return a pointer to an empty TopSearchesResponse object.

func NewTopSearchesResponse 

func NewTopSearchesResponse(searches []TopSearch) *TopSearchesResponse

NewTopSearchesResponse instantiates a new TopSearchesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopSearchesResponse) GetSearches 

func (o *TopSearchesResponse) GetSearches() []TopSearch

GetSearches returns the Searches field value.

func (*TopSearchesResponse) GetSearchesOk 

func (o *TopSearchesResponse) GetSearchesOk() ([]TopSearch, bool)

GetSearchesOk returns a tuple with the Searches field value and a boolean to check if the value has been set.

func (TopSearchesResponse) MarshalJSON 

func (o TopSearchesResponse) MarshalJSON() ([]byte, error)

func (*TopSearchesResponse) SetSearches 

func (o *TopSearchesResponse) SetSearches(v []TopSearch) *TopSearchesResponse

SetSearches sets field value.

func (TopSearchesResponse) String 

func (o TopSearchesResponse) String() string

type TopSearchesResponseWithAnalytics 

type TopSearchesResponseWithAnalytics struct {
	// Most popular searches and their associated click and conversion metrics.
	Searches []TopSearchWithAnalytics `json:"searches"`
}

TopSearchesResponseWithAnalytics struct for TopSearchesResponseWithAnalytics.

func NewEmptyTopSearchesResponseWithAnalytics 

func NewEmptyTopSearchesResponseWithAnalytics() *TopSearchesResponseWithAnalytics

NewEmptyTopSearchesResponseWithAnalytics return a pointer to an empty TopSearchesResponseWithAnalytics object.

func NewTopSearchesResponseWithAnalytics 

func NewTopSearchesResponseWithAnalytics(searches []TopSearchWithAnalytics) *TopSearchesResponseWithAnalytics

NewTopSearchesResponseWithAnalytics instantiates a new TopSearchesResponseWithAnalytics object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopSearchesResponseWithAnalytics) GetSearches 

func (o *TopSearchesResponseWithAnalytics) GetSearches() []TopSearchWithAnalytics

GetSearches returns the Searches field value.

func (*TopSearchesResponseWithAnalytics) GetSearchesOk 

func (o *TopSearchesResponseWithAnalytics) GetSearchesOk() ([]TopSearchWithAnalytics, bool)

GetSearchesOk returns a tuple with the Searches field value and a boolean to check if the value has been set.

func (TopSearchesResponseWithAnalytics) MarshalJSON 

func (o TopSearchesResponseWithAnalytics) MarshalJSON() ([]byte, error)

func (*TopSearchesResponseWithAnalytics) SetSearches 

func (o *TopSearchesResponseWithAnalytics) SetSearches(v []TopSearchWithAnalytics) *TopSearchesResponseWithAnalytics

SetSearches sets field value.

func (TopSearchesResponseWithAnalytics) String 

func (o TopSearchesResponseWithAnalytics) String() string

type TopSearchesResponseWithRevenueAnalytics 

type TopSearchesResponseWithRevenueAnalytics struct {
	// Most popular searches, including their click and revenue metrics.
	Searches []TopSearchWithRevenueAnalytics `json:"searches"`
}

TopSearchesResponseWithRevenueAnalytics struct for TopSearchesResponseWithRevenueAnalytics.

func NewEmptyTopSearchesResponseWithRevenueAnalytics 

func NewEmptyTopSearchesResponseWithRevenueAnalytics() *TopSearchesResponseWithRevenueAnalytics

NewEmptyTopSearchesResponseWithRevenueAnalytics return a pointer to an empty TopSearchesResponseWithRevenueAnalytics object.

func NewTopSearchesResponseWithRevenueAnalytics 

func NewTopSearchesResponseWithRevenueAnalytics(searches []TopSearchWithRevenueAnalytics) *TopSearchesResponseWithRevenueAnalytics

NewTopSearchesResponseWithRevenueAnalytics instantiates a new TopSearchesResponseWithRevenueAnalytics object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TopSearchesResponseWithRevenueAnalytics) GetSearches 

func (o *TopSearchesResponseWithRevenueAnalytics) GetSearches() []TopSearchWithRevenueAnalytics

GetSearches returns the Searches field value.

func (*TopSearchesResponseWithRevenueAnalytics) GetSearchesOk 

func (o *TopSearchesResponseWithRevenueAnalytics) GetSearchesOk() ([]TopSearchWithRevenueAnalytics, bool)

GetSearchesOk returns a tuple with the Searches field value and a boolean to check if the value has been set.

func (TopSearchesResponseWithRevenueAnalytics) MarshalJSON 

func (o TopSearchesResponseWithRevenueAnalytics) MarshalJSON() ([]byte, error)

func (*TopSearchesResponseWithRevenueAnalytics) SetSearches 

func (o *TopSearchesResponseWithRevenueAnalytics) SetSearches(v []TopSearchWithRevenueAnalytics) *TopSearchesResponseWithRevenueAnalytics

SetSearches sets field value.

func (TopSearchesResponseWithRevenueAnalytics) String 

func (o TopSearchesResponseWithRevenueAnalytics) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.