@algolia/client-analytics 5.0.0-alpha.73 → 5.0.0-alpha.76

package/dist/model/clickPosition.d.ts

@@ -1,10 +1,10 @@
 export type ClickPosition = {
     /**
-     * Range of positions with the following pattern: - Positions from 1 to 10 included are displayed in separated groups. - Positions from 11 to 20 included are grouped together. - Positions from 21 and up are grouped together.
+     * Range of positions with the following pattern: - For positions 1 to 10, the number of click events are shown for each position - For positions 11 to 20, all click events are grouped - For positions 21 and up, all click events are grouped.
      */
     position: number[];
     /**
-     * The number of click event.
+     * Number of click events.
      */
     clickCount: number;
 };

package/dist/model/clickThroughRateEvent.d.ts

@@ -1,18 +1,18 @@
 export type ClickThroughRateEvent = {
     /**
-     * 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 click event.
+     * Number of click events.
      */
     clickCount: 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;
     /**
-     * Date of the event.
+     * Date of the event in the format YYYY-MM-DD.
      */
     date: string;
 };

package/dist/model/clientMethodProps.d.ts

@@ -5,11 +5,11 @@ import type { OrderBy } from './orderBy';
  */
 export type DelProps = {
     /**
-     * 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>;
 };
@@ -18,11 +18,11 @@ export type DelProps = {
  */
 export type GetProps = {
     /**
-     * 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>;
 };
@@ -31,19 +31,19 @@ export type GetProps = {
  */
 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;
 };
@@ -52,19 +52,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;
 };
@@ -73,19 +73,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;
 };
@@ -94,19 +94,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;
 };
@@ -115,19 +115,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;
 };
@@ -136,19 +136,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;
 };
@@ -157,19 +157,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;
 };
@@ -178,19 +178,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;
     /**
@@ -198,7 +198,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;
 };
@@ -207,19 +207,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;
     /**
@@ -227,7 +227,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;
 };
@@ -236,7 +236,7 @@ export type GetSearchesNoResultsProps = {
  */
 export type GetStatusProps = {
     /**
-     * The index name to target.
+     * Index name to target.
      */
     index: string;
 };
@@ -245,19 +245,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;
     /**
@@ -265,7 +265,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;
 };
@@ -274,23 +274,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;
     /**
@@ -298,7 +298,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;
 };
@@ -307,27 +307,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;
     /**
@@ -335,7 +335,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;
 };
@@ -344,23 +344,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;
     /**
@@ -368,7 +368,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;
 };
@@ -377,27 +377,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;
     /**
@@ -405,7 +405,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;
 };
@@ -414,19 +414,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;
     /**
@@ -434,11 +434,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;
     /**
@@ -446,7 +446,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;
 };
@@ -455,19 +455,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;
 };
@@ -476,15 +476,15 @@ export type GetUsersCountProps = {
  */
 export type PostProps = {
     /**
-     * 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>;
     /**
-     * The parameters to send with the custom request.
+     * Parameters to send with the custom request.
      */
     body?: Record<string, any>;
 };
@@ -493,15 +493,15 @@ export type PostProps = {
  */
 export type PutProps = {
     /**
-     * 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>;
     /**
-     * The parameters to send with the custom request.
+     * Parameters to send with the custom request.
      */
     body?: Record<string, any>;
 };

package/dist/model/conversionRateEvent.d.ts

@@ -1,18 +1,18 @@
 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;
 };