@algolia/client-analytics 5.0.0-alpha.11 → 5.0.0-alpha.111

package/model/clientMethodProps.ts

@@ -1,54 +1,112 @@
-// 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 `getAddToCartRate` method.
+ */
+export type GetAddToCartRateProps = {
+  /**
+   * Index name.
+   */
+  index: string;
+  /**
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
+   */
+  startDate?: string;
+  /**
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
+   */
+  endDate?: 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/).
+   */
+  tags?: string;
+};
+
 /**
  * Properties for the `getAverageClickPosition` method.
  */
 export type GetAverageClickPositionProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -58,19 +116,19 @@ export type GetAverageClickPositionProps = {
  */
 export type GetClickPositionsProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -80,41 +138,41 @@ export type GetClickPositionsProps = {
  */
 export type GetClickThroughRateProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
 
 /**
- * Properties for the `getConversationRate` method.
+ * Properties for the `getConversionRate` method.
  */
-export type GetConversationRateProps = {
+export type GetConversionRateProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -124,19 +182,19 @@ export type GetConversationRateProps = {
  */
 export type GetNoClickRateProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -146,19 +204,63 @@ export type GetNoClickRateProps = {
  */
 export type GetNoResultsRateProps = {
   /**
-   * The index name to target.
+   * Index name.
+   */
+  index: string;
+  /**
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
+   */
+  startDate?: string;
+  /**
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
+   */
+  endDate?: 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/).
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getPurchaseRate` method.
+ */
+export type GetPurchaseRateProps = {
+  /**
+   * Index name.
+   */
+  index: string;
+  /**
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
+   */
+  startDate?: string;
+  /**
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
+   */
+  endDate?: 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/).
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getRevenue` method.
+ */
+export type GetRevenueProps = {
+  /**
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -168,19 +270,19 @@ export type GetNoResultsRateProps = {
  */
 export type GetSearchesCountProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -190,27 +292,27 @@ export type GetSearchesCountProps = {
  */
 export type GetSearchesNoClicksProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -220,27 +322,27 @@ export type GetSearchesNoClicksProps = {
  */
 export type GetSearchesNoResultsProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -250,7 +352,7 @@ export type GetSearchesNoResultsProps = {
  */
 export type GetStatusProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
 };
@@ -260,27 +362,27 @@ export type GetStatusProps = {
  */
 export type GetTopCountriesProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -290,31 +392,31 @@ export type GetTopCountriesProps = {
  */
 export type GetTopFilterAttributesProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The query term to search for. Must match the exact user input.
+   * Search query.
    */
   search?: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -324,35 +426,35 @@ export type GetTopFilterAttributesProps = {
  */
 export type GetTopFilterForAttributeProps = {
   /**
-   * The exact name of the attribute.
+   * Attribute name.
    */
   attribute: string;
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The query term to search for. Must match the exact user input.
+   * Search query.
    */
   search?: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -362,31 +464,31 @@ export type GetTopFilterForAttributeProps = {
  */
 export type GetTopFiltersNoResultsProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The query term to search for. Must match the exact user input.
+   * Search query.
    */
   search?: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -396,35 +498,39 @@ export type GetTopFiltersNoResultsProps = {
  */
 export type GetTopHitsProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The query term to search for. Must match the exact user input.
+   * Search query.
    */
   search?: string;
   /**
-   * Whether to include the click-through and conversion rates for a search.
+   * Whether to include metrics related to click and conversion events in the response.
    */
   clickAnalytics?: boolean;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+   */
+  revenueAnalytics?: boolean;
+  /**
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -434,39 +540,43 @@ export type GetTopHitsProps = {
  */
 export type GetTopSearchesProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Whether to include the click-through and conversion rates for a search.
+   * Whether to include metrics related to click and conversion events in the response.
    */
   clickAnalytics?: boolean;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+   */
+  revenueAnalytics?: boolean;
+  /**
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Reorder the results.
+   * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
    */
   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 items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   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.
+   * 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/).
    */
   tags?: string;
 };
@@ -476,55 +586,19 @@ export type GetTopSearchesProps = {
  */
 export type GetUsersCountProps = {
   /**
-   * The index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   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.
+   * 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/).
    */
   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>;
-};