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

package/dist/src/analyticsClient.d.ts

@@ -20,7 +20,7 @@ import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoRes
 import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
 import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
 import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
-export declare const apiClientVersion = "5.0.0-alpha.110";
+export declare const apiClientVersion = "5.0.0-alpha.111";
 export declare const REGIONS: readonly ["de", "us"];
 export type Region = (typeof REGIONS)[number];
 export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -92,8 +92,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getAddToCartRate - The getAddToCartRate object.
      * @param getAddToCartRate.index - Index name.
-     * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getAddToCartRate.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -106,8 +106,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getAverageClickPosition - The getAverageClickPosition object.
      * @param getAverageClickPosition.index - Index name.
-     * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getAverageClickPosition.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -120,8 +120,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getClickPositions - The getClickPositions object.
      * @param getClickPositions.index - Index name.
-     * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getClickPositions.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -134,8 +134,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getClickThroughRate - The getClickThroughRate object.
      * @param getClickThroughRate.index - Index name.
-     * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getClickThroughRate.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -148,8 +148,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getConversionRate - The getConversionRate object.
      * @param getConversionRate.index - Index name.
-     * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getConversionRate.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -162,8 +162,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getNoClickRate - The getNoClickRate object.
      * @param getNoClickRate.index - Index name.
-     * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getNoClickRate.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -176,8 +176,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getNoResultsRate - The getNoResultsRate object.
      * @param getNoResultsRate.index - Index name.
-     * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getNoResultsRate.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -190,8 +190,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getPurchaseRate - The getPurchaseRate object.
      * @param getPurchaseRate.index - Index name.
-     * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getPurchaseRate.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -204,8 +204,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getRevenue - The getRevenue object.
      * @param getRevenue.index - Index name.
-     * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getRevenue.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -218,8 +218,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getSearchesCount - The getSearchesCount object.
      * @param getSearchesCount.index - Index name.
-     * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getSearchesCount.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -232,8 +232,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getSearchesNoClicks - The getSearchesNoClicks object.
      * @param getSearchesNoClicks.index - Index name.
-     * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getSearchesNoClicks.limit - Number of items to return.
      * @param getSearchesNoClicks.offset - Position of the first item to return.
      * @param getSearchesNoClicks.tags - 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/).
@@ -248,8 +248,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getSearchesNoResults - The getSearchesNoResults object.
      * @param getSearchesNoResults.index - Index name.
-     * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getSearchesNoResults.limit - Number of items to return.
      * @param getSearchesNoResults.offset - Position of the first item to return.
      * @param getSearchesNoResults.tags - 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/).
@@ -275,8 +275,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getTopCountries - The getTopCountries object.
      * @param getTopCountries.index - Index name.
-     * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopCountries.limit - Number of items to return.
      * @param getTopCountries.offset - Position of the first item to return.
      * @param getTopCountries.tags - 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/).
@@ -292,8 +292,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopFilterAttributes - The getTopFilterAttributes object.
      * @param getTopFilterAttributes.index - Index name.
      * @param getTopFilterAttributes.search - Search query.
-     * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopFilterAttributes.limit - Number of items to return.
      * @param getTopFilterAttributes.offset - Position of the first item to return.
      * @param getTopFilterAttributes.tags - 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/).
@@ -310,8 +310,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopFilterForAttribute.attribute - Attribute name.
      * @param getTopFilterForAttribute.index - Index name.
      * @param getTopFilterForAttribute.search - Search query.
-     * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopFilterForAttribute.limit - Number of items to return.
      * @param getTopFilterForAttribute.offset - Position of the first item to return.
      * @param getTopFilterForAttribute.tags - 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/).
@@ -327,8 +327,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
      * @param getTopFiltersNoResults.index - Index name.
      * @param getTopFiltersNoResults.search - Search query.
-     * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopFiltersNoResults.limit - Number of items to return.
      * @param getTopFiltersNoResults.offset - Position of the first item to return.
      * @param getTopFiltersNoResults.tags - 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/).
@@ -346,8 +346,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopHits.search - Search query.
      * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
      * @param getTopHits.revenueAnalytics - 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 getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopHits.limit - Number of items to return.
      * @param getTopHits.offset - Position of the first item to return.
      * @param getTopHits.tags - 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/).
@@ -364,8 +364,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopSearches.index - Index name.
      * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
      * @param getTopSearches.revenueAnalytics - 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 getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopSearches.orderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
      * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
      * @param getTopSearches.limit - Number of items to return.
@@ -382,8 +382,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @param getUsersCount - The getUsersCount object.
      * @param getUsersCount.index - Index name.
-     * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-     * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getUsersCount.tags - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */

package/model/clientMethodProps.ts

@@ -76,11 +76,11 @@ export type GetAddToCartRateProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -98,11 +98,11 @@ export type GetAverageClickPositionProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -120,11 +120,11 @@ export type GetClickPositionsProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -142,11 +142,11 @@ export type GetClickThroughRateProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -164,11 +164,11 @@ export type GetConversionRateProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -186,11 +186,11 @@ export type GetNoClickRateProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -208,11 +208,11 @@ export type GetNoResultsRateProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -230,11 +230,11 @@ export type GetPurchaseRateProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -252,11 +252,11 @@ export type GetRevenueProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -274,11 +274,11 @@ export type GetSearchesCountProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -296,11 +296,11 @@ export type GetSearchesNoClicksProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -326,11 +326,11 @@ export type GetSearchesNoResultsProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -366,11 +366,11 @@ export type GetTopCountriesProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -400,11 +400,11 @@ export type GetTopFilterAttributesProps = {
    */
   search?: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -438,11 +438,11 @@ export type GetTopFilterForAttributeProps = {
    */
   search?: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -472,11 +472,11 @@ export type GetTopFiltersNoResultsProps = {
    */
   search?: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -514,11 +514,11 @@ export type GetTopHitsProps = {
    */
   revenueAnalytics?: boolean;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -552,11 +552,11 @@ export type GetTopSearchesProps = {
    */
   revenueAnalytics?: boolean;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
@@ -590,11 +590,11 @@ export type GetUsersCountProps = {
    */
   index: string;
   /**
-   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (`YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**

package/model/getStatusResponse.ts

@@ -2,7 +2,7 @@
 
 export type GetStatusResponse = {
   /**
-   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. If null, no update was performed yet.
+   * Date and time when the object was updated, in RFC 3339 format.
    */
   updatedAt: string | null;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-analytics",
-  "version": "5.0.0-alpha.110",
+  "version": "5.0.0-alpha.111",
   "description": "JavaScript client for client-analytics",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.111",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.111",
-    "@algolia/requester-node-http": "5.0.0-alpha.111"
+    "@algolia/client-common": "5.0.0-alpha.112",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.112",
+    "@algolia/requester-node-http": "5.0.0-alpha.112"
   },
   "devDependencies": {
-    "@types/node": "20.11.30",
-    "rollup": "4.13.2",
-    "typescript": "5.4.3"
+    "@types/node": "20.12.5",
+    "rollup": "4.14.0",
+    "typescript": "5.4.4"
   },
   "engines": {
     "node": ">= 14.0.0"