diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs
index 2fe809ab2e0..d339b38b932 100644
--- a/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs
+++ b/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs
@@ -498,8 +498,8 @@ public interface IAnalyticsClient
/// Index name.
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -518,8 +518,8 @@ public interface IAnalyticsClient
/// Index name.
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -538,8 +538,8 @@ public interface IAnalyticsClient
/// Index name.
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -558,8 +558,8 @@ public interface IAnalyticsClient
/// Index name.
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -608,8 +608,8 @@ public interface IAnalyticsClient
/// Index name.
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -628,8 +628,8 @@ public interface IAnalyticsClient
/// Index name.
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -649,8 +649,8 @@ public interface IAnalyticsClient
/// Search query. (optional)
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -670,8 +670,8 @@ public interface IAnalyticsClient
/// Search query. (optional)
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -692,8 +692,8 @@ public interface IAnalyticsClient
/// Search query. (optional)
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -714,8 +714,8 @@ public interface IAnalyticsClient
/// Search query. (optional)
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -735,8 +735,8 @@ public interface IAnalyticsClient
/// Search query. (optional)
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -756,8 +756,8 @@ public interface IAnalyticsClient
/// Search query. (optional)
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -779,8 +779,8 @@ public interface IAnalyticsClient
/// Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -802,8 +802,8 @@ public interface IAnalyticsClient
/// Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)
/// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -826,8 +826,8 @@ public interface IAnalyticsClient
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional)
/// Sorting direction of the results: ascending or descending. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -850,8 +850,8 @@ public interface IAnalyticsClient
/// End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional)
/// Sorting direction of the results: ascending or descending. (optional)
- /// Number of items to return. (optional, default to 10)
- /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ /// Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
/// 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/). (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
diff --git a/clients/algoliasearch-client-go/algolia/analytics/api_analytics.go b/clients/algoliasearch-client-go/algolia/analytics/api_analytics.go
index 0846711f930..96df6625a17 100644
--- a/clients/algoliasearch-client-go/algolia/analytics/api_analytics.go
+++ b/clients/algoliasearch-client-go/algolia/analytics/api_analytics.go
@@ -2702,8 +2702,8 @@ GetSearchesNoClicks calls the API and returns the raw response from it.
@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@@ -2768,8 +2768,8 @@ Request can be constructed by NewApiGetSearchesNoClicksRequest with parameters b
@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetSearchesNoClicksResponse
*/
@@ -2931,8 +2931,8 @@ GetSearchesNoResults calls the API and returns the raw response from it.
@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@@ -2997,8 +2997,8 @@ Request can be constructed by NewApiGetSearchesNoResultsRequest with parameters
@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetSearchesNoResultsResponse
*/
@@ -3288,8 +3288,8 @@ GetTopCountries calls the API and returns the raw response from it.
@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@@ -3354,8 +3354,8 @@ Request can be constructed by NewApiGetTopCountriesRequest with parameters below
@param index string - Index name.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopCountriesResponse
*/
@@ -3536,8 +3536,8 @@ These are attributes of your records that you included in the `attributesForFace
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@@ -3608,8 +3608,8 @@ Request can be constructed by NewApiGetTopFilterAttributesRequest with parameter
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopFilterAttributesResponse
*/
@@ -3802,8 +3802,8 @@ These are attributes of your records that you included in the `attributesForFace
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@@ -3879,8 +3879,8 @@ Request can be constructed by NewApiGetTopFilterForAttributeRequest with paramet
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopFilterForAttributeResponse
*/
@@ -4061,8 +4061,8 @@ To get the most frequent searches without results, use the [Retrieve searches wi
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@@ -4133,8 +4133,8 @@ Request can be constructed by NewApiGetTopFiltersNoResultsRequest with parameter
@param search string - Search query.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopFiltersNoResultsResponse
*/
@@ -4347,8 +4347,8 @@ GetTopHits calls the API and returns the raw response from it.
@param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@@ -4425,8 +4425,8 @@ Request can be constructed by NewApiGetTopHitsRequest with parameters below.
@param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
@param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopHitsResponse
*/
@@ -4656,8 +4656,8 @@ GetTopSearches calls the API and returns the raw response from it.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param orderBy OrderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
@param direction Direction - Sorting direction of the results: ascending or descending.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@@ -4738,8 +4738,8 @@ Request can be constructed by NewApiGetTopSearchesRequest with parameters below.
@param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format.
@param orderBy OrderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
@param direction Direction - Sorting direction of the results: ascending or descending.
- @param limit int32 - Number of items to return.
- @param offset int32 - Position of the first item to return.
+ @param limit int32 - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ @param offset int32 - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
@param tags string - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@return GetTopSearchesResponse
*/
diff --git a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java
index ca7dec6135d..fe8101ce35a 100644
--- a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java
+++ b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java
@@ -2008,8 +2008,10 @@ public CompletableFuture getSearchesCountAsync(@Nonnul
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2036,8 +2038,10 @@ public GetSearchesNoClicksResponse getSearchesNoClicks(
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2086,8 +2090,10 @@ public GetSearchesNoClicksResponse getSearchesNoClicks(@Nonnull String index) th
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2126,8 +2132,10 @@ public CompletableFuture getSearchesNoClicksAsync(
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2175,8 +2183,10 @@ public CompletableFuture getSearchesNoClicksAsync(@
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2202,8 +2212,10 @@ public GetSearchesNoResultsResponse getSearchesNoResults(
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2249,8 +2261,10 @@ public GetSearchesNoResultsResponse getSearchesNoResults(@Nonnull String index)
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2288,8 +2302,10 @@ public CompletableFuture getSearchesNoResultsAsync
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2387,8 +2403,10 @@ public CompletableFuture getStatusAsync(@Nonnull String index
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2414,8 +2432,10 @@ public GetTopCountriesResponse getTopCountries(
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2460,8 +2480,10 @@ public GetTopCountriesResponse getTopCountries(@Nonnull String index) throws Alg
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2499,8 +2521,10 @@ public CompletableFuture getTopCountriesAsync(
* @param index Index name. (required)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2548,8 +2572,10 @@ public CompletableFuture getTopCountriesAsync(@Nonnull
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2578,8 +2604,10 @@ public GetTopFilterAttributesResponse getTopFilterAttributes(
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2630,8 +2658,10 @@ public GetTopFilterAttributesResponse getTopFilterAttributes(@Nonnull String ind
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2673,8 +2703,10 @@ public CompletableFuture getTopFilterAttributesA
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2729,8 +2761,10 @@ public CompletableFuture getTopFilterAttributesA
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2763,8 +2797,10 @@ public GetTopFilterForAttributeResponse getTopFilterForAttribute(
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2823,8 +2859,10 @@ public GetTopFilterForAttributeResponse getTopFilterForAttribute(@Nonnull String
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2870,8 +2908,10 @@ public CompletableFuture getTopFilterForAttrib
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2932,8 +2972,10 @@ public CompletableFuture getTopFilterForAttrib
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -2963,8 +3005,10 @@ public GetTopFiltersNoResultsResponse getTopFiltersNoResults(
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3018,8 +3062,10 @@ public GetTopFiltersNoResultsResponse getTopFiltersNoResults(@Nonnull String ind
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3062,8 +3108,10 @@ public CompletableFuture getTopFiltersNoResultsA
* @param search Search query. (optional)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3123,8 +3171,10 @@ public CompletableFuture getTopFiltersNoResultsA
* (optional, default to false)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3161,8 +3211,10 @@ public GetTopHitsResponse getTopHits(
* (optional, default to false)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3216,8 +3268,10 @@ public GetTopHitsResponse getTopHits(@Nonnull String index) throws AlgoliaRuntim
* (optional, default to false)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3267,8 +3321,10 @@ public CompletableFuture getTopHitsAsync(
* (optional, default to false)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3326,8 +3382,10 @@ public CompletableFuture getTopHitsAsync(@Nonnull String ind
* parameter is false, only `searchCount` is available. (optional, default to searchCount)
* @param direction Sorting direction of the results: ascending or descending. (optional, default
* to asc)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3380,8 +3438,10 @@ public GetTopSearchesResponse getTopSearches(
* parameter is false, only `searchCount` is available. (optional, default to searchCount)
* @param direction Sorting direction of the results: ascending or descending. (optional, default
* to asc)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3439,8 +3499,10 @@ public GetTopSearchesResponse getTopSearches(@Nonnull String index) throws Algol
* parameter is false, only `searchCount` is available. (optional, default to searchCount)
* @param direction Sorting direction of the results: ascending or descending. (optional, default
* to asc)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
@@ -3495,8 +3557,10 @@ public CompletableFuture getTopSearchesAsync(
* parameter is false, only `searchCount` is available. (optional, default to searchCount)
* @param direction Sorting direction of the results: ascending or descending. (optional, default
* to asc)
- * @param limit Number of items to return. (optional, default to 10)
- * @param offset Position of the first item to return. (optional, default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first
+ * 1000 items can be retrieved. (optional, default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only
+ * the first 1000 items can be retrieved. (optional, default to 0)
* @param 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/). (optional)
diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/model/clientMethodProps.ts b/clients/algoliasearch-client-javascript/packages/client-analytics/model/clientMethodProps.ts
index 4c3cbe483ae..264c8d55c43 100644
--- a/clients/algoliasearch-client-javascript/packages/client-analytics/model/clientMethodProps.ts
+++ b/clients/algoliasearch-client-javascript/packages/client-analytics/model/clientMethodProps.ts
@@ -304,11 +304,11 @@ export type GetSearchesNoClicksProps = {
*/
endDate?: string;
/**
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
*/
limit?: number;
/**
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
*/
offset?: number;
/**
@@ -334,11 +334,11 @@ export type GetSearchesNoResultsProps = {
*/
endDate?: string;
/**
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
*/
limit?: number;
/**
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
*/
offset?: number;
/**
@@ -374,11 +374,11 @@ export type GetTopCountriesProps = {
*/
endDate?: string;
/**
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
*/
limit?: number;
/**
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
*/
offset?: number;
/**
@@ -408,11 +408,11 @@ export type GetTopFilterAttributesProps = {
*/
endDate?: string;
/**
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
*/
limit?: number;
/**
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
*/
offset?: number;
/**
@@ -446,11 +446,11 @@ export type GetTopFilterForAttributeProps = {
*/
endDate?: string;
/**
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
*/
limit?: number;
/**
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
*/
offset?: number;
/**
@@ -480,11 +480,11 @@ export type GetTopFiltersNoResultsProps = {
*/
endDate?: string;
/**
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
*/
limit?: number;
/**
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
*/
offset?: number;
/**
@@ -522,11 +522,11 @@ export type GetTopHitsProps = {
*/
endDate?: string;
/**
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
*/
limit?: number;
/**
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
*/
offset?: number;
/**
@@ -568,11 +568,11 @@ export type GetTopSearchesProps = {
*/
direction?: Direction;
/**
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
*/
limit?: number;
/**
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
*/
offset?: number;
/**
diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts b/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts
index e1194d8d66a..3bb86373bf8 100644
--- a/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts
+++ b/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts
@@ -291,7 +291,6 @@ export function createAnalyticsClient({
if (index !== undefined) {
queryParameters.index = index.toString();
}
-
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
@@ -343,7 +342,6 @@ export function createAnalyticsClient({
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
-
if (endDate !== undefined) {
queryParameters.endDate = endDate.toString();
}
@@ -388,13 +386,13 @@ export function createAnalyticsClient({
if (index !== undefined) {
queryParameters.index = index.toString();
}
+
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
if (endDate !== undefined) {
queryParameters.endDate = endDate.toString();
}
-
if (tags !== undefined) {
queryParameters.tags = tags.toString();
}
@@ -433,13 +431,14 @@ export function createAnalyticsClient({
const requestPath = '/2/clicks/clickThroughRate';
const headers: Headers = {};
const queryParameters: QueryParameters = {};
-
if (index !== undefined) {
queryParameters.index = index.toString();
}
+
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
+
if (endDate !== undefined) {
queryParameters.endDate = endDate.toString();
}
@@ -484,13 +483,13 @@ export function createAnalyticsClient({
if (index !== undefined) {
queryParameters.index = index.toString();
}
-
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
if (endDate !== undefined) {
queryParameters.endDate = endDate.toString();
}
+
if (tags !== undefined) {
queryParameters.tags = tags.toString();
}
@@ -627,7 +626,6 @@ export function createAnalyticsClient({
if (index !== undefined) {
queryParameters.index = index.toString();
}
-
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
@@ -675,9 +673,11 @@ export function createAnalyticsClient({
if (index !== undefined) {
queryParameters.index = index.toString();
}
+
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
+
if (endDate !== undefined) {
queryParameters.endDate = endDate.toString();
}
@@ -722,13 +722,13 @@ export function createAnalyticsClient({
if (index !== undefined) {
queryParameters.index = index.toString();
}
-
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
if (endDate !== undefined) {
queryParameters.endDate = endDate.toString();
}
+
if (tags !== undefined) {
queryParameters.tags = tags.toString();
}
@@ -753,8 +753,8 @@ export function createAnalyticsClient({
* @param getSearchesNoClicks.index - Index name.
* @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.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ * @param getSearchesNoClicks.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
* @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/).
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
@@ -772,6 +772,7 @@ export function createAnalyticsClient({
if (index !== undefined) {
queryParameters.index = index.toString();
}
+
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
@@ -781,10 +782,10 @@ export function createAnalyticsClient({
if (limit !== undefined) {
queryParameters.limit = limit.toString();
}
-
if (offset !== undefined) {
queryParameters.offset = offset.toString();
}
+
if (tags !== undefined) {
queryParameters.tags = tags.toString();
}
@@ -809,8 +810,8 @@ export function createAnalyticsClient({
* @param getSearchesNoResults.index - Index name.
* @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.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ * @param getSearchesNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
* @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/).
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
@@ -838,10 +839,10 @@ export function createAnalyticsClient({
if (limit !== undefined) {
queryParameters.limit = limit.toString();
}
-
if (offset !== undefined) {
queryParameters.offset = offset.toString();
}
+
if (tags !== undefined) {
queryParameters.tags = tags.toString();
}
@@ -898,8 +899,8 @@ export function createAnalyticsClient({
* @param getTopCountries.index - Index name.
* @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.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ * @param getTopCountries.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
* @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/).
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
@@ -926,7 +927,6 @@ export function createAnalyticsClient({
if (limit !== undefined) {
queryParameters.limit = limit.toString();
}
-
if (offset !== undefined) {
queryParameters.offset = offset.toString();
}
@@ -955,8 +955,8 @@ export function createAnalyticsClient({
* @param getTopFilterAttributes.search - Search query.
* @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.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ * @param getTopFilterAttributes.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
* @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/).
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
@@ -971,7 +971,6 @@ export function createAnalyticsClient({
const requestPath = '/2/filters';
const headers: Headers = {};
const queryParameters: QueryParameters = {};
-
if (index !== undefined) {
queryParameters.index = index.toString();
}
@@ -981,13 +980,13 @@ export function createAnalyticsClient({
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
+
if (endDate !== undefined) {
queryParameters.endDate = endDate.toString();
}
if (limit !== undefined) {
queryParameters.limit = limit.toString();
}
-
if (offset !== undefined) {
queryParameters.offset = offset.toString();
}
@@ -1017,8 +1016,8 @@ export function createAnalyticsClient({
* @param getTopFilterForAttribute.search - Search query.
* @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.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ * @param getTopFilterForAttribute.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
* @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/).
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
@@ -1040,10 +1039,10 @@ export function createAnalyticsClient({
if (index !== undefined) {
queryParameters.index = index.toString();
}
+
if (search !== undefined) {
queryParameters.search = search.toString();
}
-
if (startDate !== undefined) {
queryParameters.startDate = startDate.toString();
}
@@ -1053,6 +1052,7 @@ export function createAnalyticsClient({
if (limit !== undefined) {
queryParameters.limit = limit.toString();
}
+
if (offset !== undefined) {
queryParameters.offset = offset.toString();
}
@@ -1081,8 +1081,8 @@ export function createAnalyticsClient({
* @param getTopFiltersNoResults.search - Search query.
* @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.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ * @param getTopFiltersNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
* @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/).
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
@@ -1113,6 +1113,7 @@ export function createAnalyticsClient({
if (limit !== undefined) {
queryParameters.limit = limit.toString();
}
+
if (offset !== undefined) {
queryParameters.offset = offset.toString();
}
@@ -1143,8 +1144,8 @@ export function createAnalyticsClient({
* @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 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.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ * @param getTopHits.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
* @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/).
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
@@ -1213,8 +1214,8 @@ export function createAnalyticsClient({
* @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.
- * @param getTopSearches.offset - Position of the first item to return.
+ * @param getTopSearches.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+ * @param getTopSearches.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
* @param getTopSearches.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.
*/
@@ -1262,6 +1263,7 @@ export function createAnalyticsClient({
if (direction !== undefined) {
queryParameters.direction = direction.toString();
}
+
if (limit !== undefined) {
queryParameters.limit = limit.toString();
}
diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt
index 0b16cbee1d7..9c304542a89 100644
--- a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt
+++ b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt
@@ -414,8 +414,8 @@ public class AnalyticsClient(
* @param index Index name.
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
- * @param limit Number of items to return. (default to 10)
- * @param offset Position of the first item to return. (default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
* @param 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 additional request configuration.
*/
@@ -447,8 +447,8 @@ public class AnalyticsClient(
* @param index Index name.
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
- * @param limit Number of items to return. (default to 10)
- * @param offset Position of the first item to return. (default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
* @param 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 additional request configuration.
*/
@@ -503,8 +503,8 @@ public class AnalyticsClient(
* @param index Index name.
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
- * @param limit Number of items to return. (default to 10)
- * @param offset Position of the first item to return. (default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
* @param 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 additional request configuration.
*/
@@ -537,8 +537,8 @@ public class AnalyticsClient(
* @param search Search query.
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
- * @param limit Number of items to return. (default to 10)
- * @param offset Position of the first item to return. (default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
* @param 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 additional request configuration.
*/
@@ -573,8 +573,8 @@ public class AnalyticsClient(
* @param search Search query.
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
- * @param limit Number of items to return. (default to 10)
- * @param offset Position of the first item to return. (default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
* @param 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 additional request configuration.
*/
@@ -609,8 +609,8 @@ public class AnalyticsClient(
* @param search Search query.
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
- * @param limit Number of items to return. (default to 10)
- * @param offset Position of the first item to return. (default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
* @param 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 additional request configuration.
*/
@@ -646,8 +646,8 @@ public class AnalyticsClient(
* @param 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. (default to false)
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
- * @param limit Number of items to return. (default to 10)
- * @param offset Position of the first item to return. (default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
* @param 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 additional request configuration.
*/
@@ -686,8 +686,8 @@ public class AnalyticsClient(
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
* @param orderBy Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to searchCount)
* @param direction Sorting direction of the results: ascending or descending. (default to asc)
- * @param limit Number of items to return. (default to 10)
- * @param offset Position of the first item to return. (default to 0)
+ * @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ * @param offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
* @param 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 additional request configuration.
*/
diff --git a/clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php b/clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php
index 321d55174ec..5dcfe816c57 100644
--- a/clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php
+++ b/clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php
@@ -744,8 +744,8 @@ public function getSearchesCount($index, $startDate = null, $endDate = null, $ta
* @param string $index Index name. (required)
* @param string $startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param string $endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param int $limit Number of items to return. (optional, default to 10)
- * @param int $offset Position of the first item to return. (optional, default to 0)
+ * @param int $limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ * @param int $offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
* @param string $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/). (optional)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
@@ -759,6 +759,13 @@ public function getSearchesNoClicks($index, $startDate = null, $endDate = null,
'Parameter `index` is required when calling `getSearchesNoClicks`.'
);
}
+ if (null !== $limit && $limit > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$limit" when calling AnalyticsClient.getSearchesNoClicks, must be smaller than or equal to 1000.');
+ }
+
+ if (null !== $offset && $offset > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getSearchesNoClicks, must be smaller than or equal to 1000.');
+ }
if (null !== $offset && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getSearchesNoClicks, must be bigger than or equal to 0.');
}
@@ -804,8 +811,8 @@ public function getSearchesNoClicks($index, $startDate = null, $endDate = null,
* @param string $index Index name. (required)
* @param string $startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param string $endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param int $limit Number of items to return. (optional, default to 10)
- * @param int $offset Position of the first item to return. (optional, default to 0)
+ * @param int $limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ * @param int $offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
* @param string $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/). (optional)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
@@ -819,6 +826,13 @@ public function getSearchesNoResults($index, $startDate = null, $endDate = null,
'Parameter `index` is required when calling `getSearchesNoResults`.'
);
}
+ if (null !== $limit && $limit > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$limit" when calling AnalyticsClient.getSearchesNoResults, must be smaller than or equal to 1000.');
+ }
+
+ if (null !== $offset && $offset > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getSearchesNoResults, must be smaller than or equal to 1000.');
+ }
if (null !== $offset && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getSearchesNoResults, must be bigger than or equal to 0.');
}
@@ -896,8 +910,8 @@ public function getStatus($index, $requestOptions = [])
* @param string $index Index name. (required)
* @param string $startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param string $endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param int $limit Number of items to return. (optional, default to 10)
- * @param int $offset Position of the first item to return. (optional, default to 0)
+ * @param int $limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ * @param int $offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
* @param string $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/). (optional)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
@@ -911,6 +925,13 @@ public function getTopCountries($index, $startDate = null, $endDate = null, $lim
'Parameter `index` is required when calling `getTopCountries`.'
);
}
+ if (null !== $limit && $limit > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$limit" when calling AnalyticsClient.getTopCountries, must be smaller than or equal to 1000.');
+ }
+
+ if (null !== $offset && $offset > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopCountries, must be smaller than or equal to 1000.');
+ }
if (null !== $offset && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopCountries, must be bigger than or equal to 0.');
}
@@ -957,8 +978,8 @@ public function getTopCountries($index, $startDate = null, $endDate = null, $lim
* @param string $search Search query. (optional)
* @param string $startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param string $endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param int $limit Number of items to return. (optional, default to 10)
- * @param int $offset Position of the first item to return. (optional, default to 0)
+ * @param int $limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ * @param int $offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
* @param string $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/). (optional)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
@@ -972,6 +993,13 @@ public function getTopFilterAttributes($index, $search = null, $startDate = null
'Parameter `index` is required when calling `getTopFilterAttributes`.'
);
}
+ if (null !== $limit && $limit > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$limit" when calling AnalyticsClient.getTopFilterAttributes, must be smaller than or equal to 1000.');
+ }
+
+ if (null !== $offset && $offset > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopFilterAttributes, must be smaller than or equal to 1000.');
+ }
if (null !== $offset && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopFilterAttributes, must be bigger than or equal to 0.');
}
@@ -1023,8 +1051,8 @@ public function getTopFilterAttributes($index, $search = null, $startDate = null
* @param string $search Search query. (optional)
* @param string $startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param string $endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param int $limit Number of items to return. (optional, default to 10)
- * @param int $offset Position of the first item to return. (optional, default to 0)
+ * @param int $limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ * @param int $offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
* @param string $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/). (optional)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
@@ -1044,6 +1072,13 @@ public function getTopFilterForAttribute($attribute, $index, $search = null, $st
'Parameter `index` is required when calling `getTopFilterForAttribute`.'
);
}
+ if (null !== $limit && $limit > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$limit" when calling AnalyticsClient.getTopFilterForAttribute, must be smaller than or equal to 1000.');
+ }
+
+ if (null !== $offset && $offset > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopFilterForAttribute, must be smaller than or equal to 1000.');
+ }
if (null !== $offset && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopFilterForAttribute, must be bigger than or equal to 0.');
}
@@ -1103,8 +1138,8 @@ public function getTopFilterForAttribute($attribute, $index, $search = null, $st
* @param string $search Search query. (optional)
* @param string $startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param string $endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param int $limit Number of items to return. (optional, default to 10)
- * @param int $offset Position of the first item to return. (optional, default to 0)
+ * @param int $limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ * @param int $offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
* @param string $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/). (optional)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
@@ -1118,6 +1153,13 @@ public function getTopFiltersNoResults($index, $search = null, $startDate = null
'Parameter `index` is required when calling `getTopFiltersNoResults`.'
);
}
+ if (null !== $limit && $limit > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$limit" when calling AnalyticsClient.getTopFiltersNoResults, must be smaller than or equal to 1000.');
+ }
+
+ if (null !== $offset && $offset > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopFiltersNoResults, must be smaller than or equal to 1000.');
+ }
if (null !== $offset && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopFiltersNoResults, must be bigger than or equal to 0.');
}
@@ -1170,8 +1212,8 @@ public function getTopFiltersNoResults($index, $search = null, $startDate = null
* @param bool $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. (optional, default to false)
* @param string $startDate Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param string $endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- * @param int $limit Number of items to return. (optional, default to 10)
- * @param int $offset Position of the first item to return. (optional, default to 0)
+ * @param int $limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ * @param int $offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
* @param string $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/). (optional)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
@@ -1185,6 +1227,13 @@ public function getTopHits($index, $search = null, $clickAnalytics = null, $reve
'Parameter `index` is required when calling `getTopHits`.'
);
}
+ if (null !== $limit && $limit > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$limit" when calling AnalyticsClient.getTopHits, must be smaller than or equal to 1000.');
+ }
+
+ if (null !== $offset && $offset > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopHits, must be smaller than or equal to 1000.');
+ }
if (null !== $offset && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopHits, must be bigger than or equal to 0.');
}
@@ -1246,8 +1295,8 @@ public function getTopHits($index, $search = null, $clickAnalytics = null, $reve
* @param string $endDate End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
* @param array $orderBy Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional)
* @param array $direction Sorting direction of the results: ascending or descending. (optional)
- * @param int $limit Number of items to return. (optional, default to 10)
- * @param int $offset Position of the first item to return. (optional, default to 0)
+ * @param int $limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (optional, default to 10)
+ * @param int $offset Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (optional, default to 0)
* @param string $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/). (optional)
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
*
@@ -1261,6 +1310,13 @@ public function getTopSearches($index, $clickAnalytics = null, $revenueAnalytics
'Parameter `index` is required when calling `getTopSearches`.'
);
}
+ if (null !== $limit && $limit > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$limit" when calling AnalyticsClient.getTopSearches, must be smaller than or equal to 1000.');
+ }
+
+ if (null !== $offset && $offset > 1000) {
+ throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopSearches, must be smaller than or equal to 1000.');
+ }
if (null !== $offset && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling AnalyticsClient.getTopSearches, must be bigger than or equal to 0.');
}
diff --git a/clients/algoliasearch-client-python/algoliasearch/analytics/client.py b/clients/algoliasearch-client-python/algoliasearch/analytics/client.py
index e710db95191..ec71be32ed6 100644
--- a/clients/algoliasearch-client-python/algoliasearch/analytics/client.py
+++ b/clients/algoliasearch-client-python/algoliasearch/analytics/client.py
@@ -11,7 +11,7 @@
from typing import Any, Dict, List, Optional, Tuple, Union
from urllib.parse import quote
-from pydantic import Field, StrictBool, StrictInt, StrictStr
+from pydantic import Field, StrictBool, StrictStr
from typing_extensions import Annotated
if version_info >= (3, 11):
@@ -1639,11 +1639,16 @@ async def get_searches_no_clicks_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -1665,9 +1670,9 @@ async def get_searches_no_clicks_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -1721,11 +1726,16 @@ async def get_searches_no_clicks(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -1747,9 +1757,9 @@ async def get_searches_no_clicks(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -1777,11 +1787,16 @@ async def get_searches_no_results_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -1803,9 +1818,9 @@ async def get_searches_no_results_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -1859,11 +1874,16 @@ async def get_searches_no_results(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -1885,9 +1905,9 @@ async def get_searches_no_results(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -1969,11 +1989,16 @@ async def get_top_countries_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -1995,9 +2020,9 @@ async def get_top_countries_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2051,11 +2076,16 @@ async def get_top_countries(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2077,9 +2107,9 @@ async def get_top_countries(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2110,11 +2140,16 @@ async def get_top_filter_attributes_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2138,9 +2173,9 @@ async def get_top_filter_attributes_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2199,11 +2234,16 @@ async def get_top_filter_attributes(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2227,9 +2267,9 @@ async def get_top_filter_attributes(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2261,11 +2301,16 @@ async def get_top_filter_for_attribute_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2291,9 +2336,9 @@ async def get_top_filter_for_attribute_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2360,11 +2405,16 @@ async def get_top_filter_for_attribute(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2390,9 +2440,9 @@ async def get_top_filter_for_attribute(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2431,11 +2481,16 @@ async def get_top_filters_no_results_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2459,9 +2514,9 @@ async def get_top_filters_no_results_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2520,11 +2575,16 @@ async def get_top_filters_no_results(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2548,9 +2608,9 @@ async def get_top_filters_no_results(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2593,11 +2653,16 @@ async def get_top_hits_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2625,9 +2690,9 @@ async def get_top_hits_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2702,11 +2767,16 @@ async def get_top_hits(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2734,9 +2804,9 @@ async def get_top_hits(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2797,11 +2867,16 @@ async def get_top_searches_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2831,9 +2906,9 @@ async def get_top_searches_with_http_info(
:type order_by: OrderBy
:param direction: Sorting direction of the results: ascending or descending.
:type direction: Direction
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -2919,11 +2994,16 @@ async def get_top_searches(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -2953,9 +3033,9 @@ async def get_top_searches(
:type order_by: OrderBy
:param direction: Sorting direction of the results: ascending or descending.
:type direction: Direction
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -4638,11 +4718,16 @@ def get_searches_no_clicks_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -4664,9 +4749,9 @@ def get_searches_no_clicks_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -4720,11 +4805,16 @@ def get_searches_no_clicks(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -4746,9 +4836,9 @@ def get_searches_no_clicks(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -4776,11 +4866,16 @@ def get_searches_no_results_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -4802,9 +4897,9 @@ def get_searches_no_results_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -4858,11 +4953,16 @@ def get_searches_no_results(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -4884,9 +4984,9 @@ def get_searches_no_results(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -4968,11 +5068,16 @@ def get_top_countries_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -4994,9 +5099,9 @@ def get_top_countries_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5050,11 +5155,16 @@ def get_top_countries(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5076,9 +5186,9 @@ def get_top_countries(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5109,11 +5219,16 @@ def get_top_filter_attributes_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5137,9 +5252,9 @@ def get_top_filter_attributes_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5198,11 +5313,16 @@ def get_top_filter_attributes(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5226,9 +5346,9 @@ def get_top_filter_attributes(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5260,11 +5380,16 @@ def get_top_filter_for_attribute_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5290,9 +5415,9 @@ def get_top_filter_for_attribute_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5359,11 +5484,16 @@ def get_top_filter_for_attribute(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5389,9 +5519,9 @@ def get_top_filter_for_attribute(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5430,11 +5560,16 @@ def get_top_filters_no_results_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5458,9 +5593,9 @@ def get_top_filters_no_results_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5519,11 +5654,16 @@ def get_top_filters_no_results(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5547,9 +5687,9 @@ def get_top_filters_no_results(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5592,11 +5732,16 @@ def get_top_hits_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5624,9 +5769,9 @@ def get_top_hits_with_http_info(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5701,11 +5846,16 @@ def get_top_hits(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5733,9 +5883,9 @@ def get_top_hits(
:type start_date: str
:param end_date: End date of the period to analyze, in `YYYY-MM-DD` format.
:type end_date: str
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5796,11 +5946,16 @@ def get_top_searches_with_http_info(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5830,9 +5985,9 @@ def get_top_searches_with_http_info(
:type order_by: OrderBy
:param direction: Sorting direction of the results: ascending or descending.
:type direction: Direction
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
@@ -5918,11 +6073,16 @@ def get_top_searches(
),
] = None,
limit: Annotated[
- Optional[StrictInt], Field(description="Number of items to return.")
+ Optional[Annotated[int, Field(le=1000, strict=True)]],
+ Field(
+ description="Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
offset: Annotated[
- Optional[Annotated[int, Field(strict=True, ge=0)]],
- Field(description="Position of the first item to return."),
+ Optional[Annotated[int, Field(le=1000, strict=True, ge=0)]],
+ Field(
+ description="Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. "
+ ),
] = None,
tags: Annotated[
Optional[StrictStr],
@@ -5952,9 +6112,9 @@ def get_top_searches(
:type order_by: OrderBy
:param direction: Sorting direction of the results: ascending or descending.
:type direction: Direction
- :param limit: Number of items to return.
+ :param limit: Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
:type limit: int
- :param offset: Position of the first item to return.
+ :param offset: Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
:type offset: int
:param 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/).
:type tags: str
diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/analytics_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/analytics_client.rb
index 00ecf4bf93b..eb544d48ac9 100644
--- a/clients/algoliasearch-client-ruby/lib/algolia/api/analytics_client.rb
+++ b/clients/algoliasearch-client-ruby/lib/algolia/api/analytics_client.rb
@@ -800,8 +800,8 @@ def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, requ
# @param index [String] Index name. (required)
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [Http::Response] the response
@@ -819,6 +819,20 @@ def get_searches_no_clicks_with_http_info(
raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_clicks`."
end
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_searches_no_clicks, must be smaller than or equal to 1000."
+ )
+ end
+
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_clicks, must be smaller than or equal to 1000."
+ )
+ end
+
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
raise(
ArgumentError,
@@ -858,8 +872,8 @@ def get_searches_no_clicks_with_http_info(
# @param index [String] Index name. (required)
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [GetSearchesNoClicksResponse]
@@ -894,8 +908,8 @@ def get_searches_no_clicks(
# @param index [String] Index name. (required)
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [Http::Response] the response
@@ -913,6 +927,20 @@ def get_searches_no_results_with_http_info(
raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_results`."
end
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_searches_no_results, must be smaller than or equal to 1000."
+ )
+ end
+
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_results, must be smaller than or equal to 1000."
+ )
+ end
+
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
raise(
ArgumentError,
@@ -952,8 +980,8 @@ def get_searches_no_results_with_http_info(
# @param index [String] Index name. (required)
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [GetSearchesNoResultsResponse]
@@ -1033,8 +1061,8 @@ def get_status(index, request_options = {})
# @param index [String] Index name. (required)
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [Http::Response] the response
@@ -1052,6 +1080,20 @@ def get_top_countries_with_http_info(
raise ArgumentError, "Parameter `index` is required when calling `get_top_countries`."
end
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_countries, must be smaller than or equal to 1000."
+ )
+ end
+
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_countries, must be smaller than or equal to 1000."
+ )
+ end
+
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
raise(
ArgumentError,
@@ -1091,8 +1133,8 @@ def get_top_countries_with_http_info(
# @param index [String] Index name. (required)
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [GetTopCountriesResponse]
@@ -1120,8 +1162,8 @@ def get_top_countries(
# @param search [String] Search query.
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [Http::Response] the response
@@ -1140,6 +1182,20 @@ def get_top_filter_attributes_with_http_info(
raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_attributes`."
end
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filter_attributes, must be smaller than or equal to 1000."
+ )
+ end
+
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_attributes, must be smaller than or equal to 1000."
+ )
+ end
+
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
raise(
ArgumentError,
@@ -1181,8 +1237,8 @@ def get_top_filter_attributes_with_http_info(
# @param search [String] Search query.
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [GetTopFilterAttributesResponse]
@@ -1221,8 +1277,8 @@ def get_top_filter_attributes(
# @param search [String] Search query.
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [Http::Response] the response
@@ -1246,6 +1302,20 @@ def get_top_filter_for_attribute_with_http_info(
raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_for_attribute`."
end
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be smaller than or equal to 1000."
+ )
+ end
+
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be smaller than or equal to 1000."
+ )
+ end
+
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
raise(
ArgumentError,
@@ -1288,8 +1358,8 @@ def get_top_filter_for_attribute_with_http_info(
# @param search [String] Search query.
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [GetTopFilterForAttributeResponse]
@@ -1329,8 +1399,8 @@ def get_top_filter_for_attribute(
# @param search [String] Search query.
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [Http::Response] the response
@@ -1349,6 +1419,20 @@ def get_top_filters_no_results_with_http_info(
raise ArgumentError, "Parameter `index` is required when calling `get_top_filters_no_results`."
end
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filters_no_results, must be smaller than or equal to 1000."
+ )
+ end
+
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filters_no_results, must be smaller than or equal to 1000."
+ )
+ end
+
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
raise(
ArgumentError,
@@ -1390,8 +1474,8 @@ def get_top_filters_no_results_with_http_info(
# @param search [String] Search query.
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [GetTopFiltersNoResultsResponse]
@@ -1431,8 +1515,8 @@ def get_top_filters_no_results(
# @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false)
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [Http::Response] the response
@@ -1453,6 +1537,20 @@ def get_top_hits_with_http_info(
raise ArgumentError, "Parameter `index` is required when calling `get_top_hits`."
end
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_hits, must be smaller than or equal to 1000."
+ )
+ end
+
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_hits, must be smaller than or equal to 1000."
+ )
+ end
+
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
raise(
ArgumentError,
@@ -1498,8 +1596,8 @@ def get_top_hits_with_http_info(
# @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false)
# @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [GetTopHitsResponse]
@@ -1541,8 +1639,8 @@ def get_top_hits(
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
# @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount')
# @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc')
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [Http::Response] the response
@@ -1564,6 +1662,20 @@ def get_top_searches_with_http_info(
raise ArgumentError, "Parameter `index` is required when calling `get_top_searches`."
end
+ if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_searches, must be smaller than or equal to 1000."
+ )
+ end
+
+ if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
+ raise(
+ ArgumentError,
+ "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_searches, must be smaller than or equal to 1000."
+ )
+ end
+
if @api_client.config.client_side_validation && !offset.nil? && offset < 0
raise(
ArgumentError,
@@ -1611,8 +1723,8 @@ def get_top_searches_with_http_info(
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
# @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount')
# @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc')
- # @param limit [Integer] Number of items to return. (default to 10)
- # @param offset [Integer] Position of the first item to return. (default to 0)
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
+ # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0)
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
# @return [GetTopSearchesResponse]
diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/AnalyticsClient.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/AnalyticsClient.scala
index 9513da68775..be63bba3a8b 100644
--- a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/AnalyticsClient.scala
+++ b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/AnalyticsClient.scala
@@ -580,9 +580,10 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* @param offset
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
+ * retrieved.
* @param 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
@@ -625,9 +626,10 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* @param offset
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
+ * retrieved.
* @param 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
@@ -693,9 +695,10 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* @param offset
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
+ * retrieved.
* @param 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
@@ -741,9 +744,10 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* @param offset
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
+ * retrieved.
* @param 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
@@ -793,9 +797,10 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* @param offset
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
+ * retrieved.
* @param 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
@@ -846,9 +851,10 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* @param offset
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
+ * retrieved.
* @param 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
@@ -900,9 +906,10 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* @param offset
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
+ * retrieved.
* @param 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
@@ -961,9 +968,10 @@ class AnalyticsClient(
* @param direction
* Sorting direction of the results: ascending or descending.
* @param limit
- * Number of items to return.
+ * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* @param offset
- * Position of the first item to return.
+ * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
+ * retrieved.
* @param 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
diff --git a/clients/algoliasearch-client-swift/Sources/Analytics/AnalyticsClient.swift b/clients/algoliasearch-client-swift/Sources/Analytics/AnalyticsClient.swift
index a86c5fd9d0e..b83240f5756 100644
--- a/clients/algoliasearch-client-swift/Sources/Analytics/AnalyticsClient.swift
+++ b/clients/algoliasearch-client-swift/Sources/Analytics/AnalyticsClient.swift
@@ -1078,8 +1078,10 @@ open class AnalyticsClient {
/// - parameter index: (query) Index name.
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// - parameter limit: (query) Number of items to return. (optional, default to 10)
- /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ /// items can be retrieved. (optional, default to 10)
+ /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ /// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter tags: (query) 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/). (optional)
@@ -1121,9 +1123,11 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
- // - parameter limit: (query) Number of items to return. (optional, default to 10)
+ // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ // items can be retrieved. (optional, default to 10)
//
- // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ // first 1000 items can be retrieved. (optional, default to 0)
//
// - parameter tags: (query) 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
@@ -1169,8 +1173,10 @@ open class AnalyticsClient {
/// - parameter index: (query) Index name.
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// - parameter limit: (query) Number of items to return. (optional, default to 10)
- /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ /// items can be retrieved. (optional, default to 10)
+ /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ /// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter tags: (query) 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/). (optional)
@@ -1212,9 +1218,11 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
- // - parameter limit: (query) Number of items to return. (optional, default to 10)
+ // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ // items can be retrieved. (optional, default to 10)
//
- // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ // first 1000 items can be retrieved. (optional, default to 0)
//
// - parameter tags: (query) 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
@@ -1310,8 +1318,10 @@ open class AnalyticsClient {
/// - parameter index: (query) Index name.
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// - parameter limit: (query) Number of items to return. (optional, default to 10)
- /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ /// items can be retrieved. (optional, default to 10)
+ /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ /// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter tags: (query) 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/). (optional)
@@ -1353,9 +1363,11 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
- // - parameter limit: (query) Number of items to return. (optional, default to 10)
+ // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ // items can be retrieved. (optional, default to 10)
//
- // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ // first 1000 items can be retrieved. (optional, default to 0)
//
// - parameter tags: (query) 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
@@ -1402,8 +1414,10 @@ open class AnalyticsClient {
/// - parameter search: (query) Search query. (optional)
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// - parameter limit: (query) Number of items to return. (optional, default to 10)
- /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ /// items can be retrieved. (optional, default to 10)
+ /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ /// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter tags: (query) 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/). (optional)
@@ -1450,9 +1464,11 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
- // - parameter limit: (query) Number of items to return. (optional, default to 10)
+ // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ // items can be retrieved. (optional, default to 10)
//
- // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ // first 1000 items can be retrieved. (optional, default to 0)
//
// - parameter tags: (query) 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
@@ -1502,8 +1518,10 @@ open class AnalyticsClient {
/// - parameter search: (query) Search query. (optional)
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// - parameter limit: (query) Number of items to return. (optional, default to 10)
- /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ /// items can be retrieved. (optional, default to 10)
+ /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ /// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter tags: (query) 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/). (optional)
@@ -1554,9 +1572,11 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
- // - parameter limit: (query) Number of items to return. (optional, default to 10)
+ // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ // items can be retrieved. (optional, default to 10)
//
- // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ // first 1000 items can be retrieved. (optional, default to 0)
//
// - parameter tags: (query) 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
@@ -1619,8 +1639,10 @@ open class AnalyticsClient {
/// - parameter search: (query) Search query. (optional)
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// - parameter limit: (query) Number of items to return. (optional, default to 10)
- /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ /// items can be retrieved. (optional, default to 10)
+ /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ /// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter tags: (query) 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/). (optional)
@@ -1668,9 +1690,11 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
- // - parameter limit: (query) Number of items to return. (optional, default to 10)
+ // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ // items can be retrieved. (optional, default to 10)
//
- // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ // first 1000 items can be retrieved. (optional, default to 0)
//
// - parameter tags: (query) 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
@@ -1723,8 +1747,10 @@ open class AnalyticsClient {
/// metrics related to click and conversion events are also included in the response. (optional, default to false)
/// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)
/// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
- /// - parameter limit: (query) Number of items to return. (optional, default to 10)
- /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ /// items can be retrieved. (optional, default to 10)
+ /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ /// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter tags: (query) 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/). (optional)
@@ -1780,9 +1806,11 @@ open class AnalyticsClient {
//
// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. (optional)
//
- // - parameter limit: (query) Number of items to return. (optional, default to 10)
+ // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ // items can be retrieved. (optional, default to 10)
//
- // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ // first 1000 items can be retrieved. (optional, default to 0)
//
// - parameter tags: (query) 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
@@ -1841,8 +1869,10 @@ open class AnalyticsClient {
/// - parameter orderBy: (query) Attribute by which to order the response items. If the `clickAnalytics` parameter
/// is false, only `searchCount` is available. (optional)
/// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional)
- /// - parameter limit: (query) Number of items to return. (optional, default to 10)
- /// - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ /// - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ /// items can be retrieved. (optional, default to 10)
+ /// - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ /// first 1000 items can be retrieved. (optional, default to 0)
/// - parameter tags: (query) 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/). (optional)
@@ -1903,9 +1933,11 @@ open class AnalyticsClient {
//
// - parameter direction: (query) Sorting direction of the results: ascending or descending. (optional)
//
- // - parameter limit: (query) Number of items to return. (optional, default to 10)
+ // - parameter limit: (query) Number of items to return. Combined with the `offset` parameter, only the first 1000
+ // items can be retrieved. (optional, default to 10)
//
- // - parameter offset: (query) Position of the first item to return. (optional, default to 0)
+ // - parameter offset: (query) Position of the first item to return. Combined with the `limit` parameter, only the
+ // first 1000 items can be retrieved. (optional, default to 0)
//
// - parameter tags: (query) 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
diff --git a/specs/bundled/abtesting.doc.yml b/specs/bundled/abtesting.doc.yml
index 8554454ff7d..9ca2e2f4f94 100644
--- a/specs/bundled/abtesting.doc.yml
+++ b/specs/bundled/abtesting.doc.yml
@@ -1498,8 +1498,21 @@ paths:
summary: List all A/B tests
description: Lists all A/B tests you configured for this application.
parameters:
- - $ref: '#/components/parameters/Offset'
- - $ref: '#/components/parameters/Limit'
+ - name: offset
+ in: query
+ description: Position of the first item to return.
+ required: false
+ schema:
+ type: integer
+ default: 0
+ minimum: 0
+ - name: limit
+ in: query
+ description: Number of items to return.
+ required: false
+ schema:
+ type: integer
+ default: 10
- name: indexPrefix
in: query
description: >-
@@ -2970,23 +2983,6 @@ components:
schema:
type: object
additionalProperties: true
- Offset:
- in: query
- name: offset
- description: Position of the first item to return.
- required: false
- schema:
- type: integer
- default: 0
- minimum: 0
- Limit:
- in: query
- name: limit
- description: Number of items to return.
- required: false
- schema:
- type: integer
- default: 10
ID:
in: path
name: id
diff --git a/specs/bundled/abtesting.yml b/specs/bundled/abtesting.yml
index cba99dad68f..cfdee2662db 100644
--- a/specs/bundled/abtesting.yml
+++ b/specs/bundled/abtesting.yml
@@ -287,8 +287,21 @@ paths:
summary: List all A/B tests
description: Lists all A/B tests you configured for this application.
parameters:
- - $ref: '#/components/parameters/Offset'
- - $ref: '#/components/parameters/Limit'
+ - name: offset
+ in: query
+ description: Position of the first item to return.
+ required: false
+ schema:
+ type: integer
+ default: 0
+ minimum: 0
+ - name: limit
+ in: query
+ description: Number of items to return.
+ required: false
+ schema:
+ type: integer
+ default: 10
- name: indexPrefix
in: query
description: >-
@@ -559,23 +572,6 @@ components:
schema:
type: object
additionalProperties: true
- Offset:
- in: query
- name: offset
- description: Position of the first item to return.
- required: false
- schema:
- type: integer
- default: 0
- minimum: 0
- Limit:
- in: query
- name: limit
- description: Number of items to return.
- required: false
- schema:
- type: integer
- default: 10
ID:
in: path
name: id
diff --git a/specs/bundled/analytics.doc.yml b/specs/bundled/analytics.doc.yml
index d67858e8aa5..8c0030c11e7 100644
--- a/specs/bundled/analytics.doc.yml
+++ b/specs/bundled/analytics.doc.yml
@@ -6909,20 +6909,32 @@ components:
Limit:
in: query
name: limit
- description: Number of items to return.
+ description: >
+ Number of items to return.
+
+
+ Combined with the `offset` parameter, only the first 1000 items can be
+ retrieved.
required: false
schema:
type: integer
default: 10
+ maximum: 1000
Offset:
in: query
name: offset
- description: Position of the first item to return.
+ description: >
+ Position of the first item to return.
+
+
+ Combined with the `limit` parameter, only the first 1000 items can be
+ retrieved.
required: false
schema:
type: integer
default: 0
minimum: 0
+ maximum: 1000
Tags:
name: tags
in: query
diff --git a/specs/bundled/analytics.yml b/specs/bundled/analytics.yml
index 5977d90b57a..056695d9575 100644
--- a/specs/bundled/analytics.yml
+++ b/specs/bundled/analytics.yml
@@ -1592,20 +1592,32 @@ components:
Limit:
in: query
name: limit
- description: Number of items to return.
+ description: >
+ Number of items to return.
+
+
+ Combined with the `offset` parameter, only the first 1000 items can be
+ retrieved.
required: false
schema:
type: integer
default: 10
+ maximum: 1000
Offset:
in: query
name: offset
- description: Position of the first item to return.
+ description: >
+ Position of the first item to return.
+
+
+ Combined with the `limit` parameter, only the first 1000 items can be
+ retrieved.
required: false
schema:
type: integer
default: 0
minimum: 0
+ maximum: 1000
Tags:
name: tags
in: query