@algolia/client-analytics 5.0.0-alpha.1 → 5.0.0-alpha.100

package/model/clientMethodProps.ts

@@ -1,54 +1,90 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 import type { Direction } from './direction';
 import type { OrderBy } from './orderBy';
 
 /**
- * Properties for the `del` method.
+ * Properties for the `customDelete` method.
  */
-export type DelProps = {
+export type CustomDeleteProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
 
 /**
- * Properties for the `get` method.
+ * Properties for the `customGet` method.
  */
-export type GetProps = {
+export type CustomGetProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
 
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `customPut` method.
+ */
+export type CustomPutProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
 /**
  * Properties for the `getAverageClickPosition` method.
  */
 export type GetAverageClickPositionProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -58,19 +94,19 @@ export type GetAverageClickPositionProps = {
  */
 export type GetClickPositionsProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -80,19 +116,19 @@ export type GetClickPositionsProps = {
  */
 export type GetClickThroughRateProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -102,19 +138,19 @@ export type GetClickThroughRateProps = {
  */
 export type GetConversationRateProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -124,19 +160,19 @@ export type GetConversationRateProps = {
  */
 export type GetNoClickRateProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -146,19 +182,19 @@ export type GetNoClickRateProps = {
  */
 export type GetNoResultsRateProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -168,19 +204,19 @@ export type GetNoResultsRateProps = {
  */
 export type GetSearchesCountProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -190,19 +226,19 @@ export type GetSearchesCountProps = {
  */
 export type GetSearchesNoClicksProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   limit?: number;
   /**
@@ -210,7 +246,7 @@ export type GetSearchesNoClicksProps = {
    */
   offset?: number;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -220,19 +256,19 @@ export type GetSearchesNoClicksProps = {
  */
 export type GetSearchesNoResultsProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   limit?: number;
   /**
@@ -240,7 +276,7 @@ export type GetSearchesNoResultsProps = {
    */
   offset?: number;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -250,7 +286,7 @@ export type GetSearchesNoResultsProps = {
  */
 export type GetStatusProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
 };
@@ -260,19 +296,19 @@ export type GetStatusProps = {
  */
 export type GetTopCountriesProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   limit?: number;
   /**
@@ -280,7 +316,7 @@ export type GetTopCountriesProps = {
    */
   offset?: number;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -290,23 +326,23 @@ export type GetTopCountriesProps = {
  */
 export type GetTopFilterAttributesProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The query term to search for. Must match the exact user input.
+   * User query.
    */
   search?: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   limit?: number;
   /**
@@ -314,7 +350,7 @@ export type GetTopFilterAttributesProps = {
    */
   offset?: number;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -324,27 +360,27 @@ export type GetTopFilterAttributesProps = {
  */
 export type GetTopFilterForAttributeProps = {
   /**
-   * The exact name of the attribute.
+   * Attribute name.
    */
   attribute: string;
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The query term to search for. Must match the exact user input.
+   * User query.
    */
   search?: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   limit?: number;
   /**
@@ -352,7 +388,7 @@ export type GetTopFilterForAttributeProps = {
    */
   offset?: number;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -362,23 +398,23 @@ export type GetTopFilterForAttributeProps = {
  */
 export type GetTopFiltersNoResultsProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The query term to search for. Must match the exact user input.
+   * User query.
    */
   search?: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   limit?: number;
   /**
@@ -386,7 +422,7 @@ export type GetTopFiltersNoResultsProps = {
    */
   offset?: number;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -396,27 +432,27 @@ export type GetTopFiltersNoResultsProps = {
  */
 export type GetTopHitsProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The query term to search for. Must match the exact user input.
+   * User query.
    */
   search?: string;
   /**
-   * Whether to include the click-through and conversion rates for a search.
+   * Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
    */
   clickAnalytics?: boolean;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   limit?: number;
   /**
@@ -424,7 +460,7 @@ export type GetTopHitsProps = {
    */
   offset?: number;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -434,19 +470,19 @@ export type GetTopHitsProps = {
  */
 export type GetTopSearchesProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * Whether to include the click-through and conversion rates for a search.
+   * Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
    */
   clickAnalytics?: boolean;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
@@ -454,11 +490,11 @@ export type GetTopSearchesProps = {
    */
   orderBy?: OrderBy;
   /**
-   * The sorting of the result.
+   * Sorting direction of the results: ascending or descending.
    */
   direction?: Direction;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   limit?: number;
   /**
@@ -466,7 +502,7 @@ export type GetTopSearchesProps = {
    */
   offset?: number;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
@@ -476,55 +512,19 @@ export type GetTopSearchesProps = {
  */
 export type GetUsersCountProps = {
   /**
-   * The index name to target.
+   * Index name to target.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
    */
   tags?: string;
 };
-
-/**
- * Properties for the `post` method.
- */
-export type PostProps = {
-  /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to be applied to the current query.
-   */
-  parameters?: Record<string, any>;
-  /**
-   * The parameters to send with the custom request.
-   */
-  body?: Record<string, any>;
-};
-
-/**
- * Properties for the `put` method.
- */
-export type PutProps = {
-  /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to be applied to the current query.
-   */
-  parameters?: Record<string, any>;
-  /**
-   * The parameters to send with the custom request.
-   */
-  body?: Record<string, any>;
-};

package/model/conversionRateEvent.ts

@@ -1,20 +1,23 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type ConversionRateEvent = {
   /**
-   * The click-through rate.
+   * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
    */
   rate: number;
+
   /**
-   * The number of tracked search click.
+   * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
    */
   trackedSearchCount: number;
+
   /**
-   * The number of converted clicks.
+   * Number of converted clicks.
    */
   conversionCount: number;
+
   /**
-   * Date of the event.
+   * Date of the event in the format YYYY-MM-DD.
    */
   date: string;
 };

package/model/direction.ts

@@ -1,3 +1,3 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type Direction = 'asc' | 'desc';