From 1f3e78d3dfd24787b8f8c2ab9c7db1bb84302635 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Mon, 21 Oct 2024 14:24:51 +0000 Subject: [PATCH] docs(analytics): constrain pagination only to limit query parameter (generated) https://github.com/algolia/api-clients-automation/pull/4012 Co-authored-by: algolia-bot Co-authored-by: Fernando Beck Co-authored-by: shortcuts --- algoliasearch/Clients/AnalyticsClient.cs | 64 ++++++++++++------------ 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/algoliasearch/Clients/AnalyticsClient.cs b/algoliasearch/Clients/AnalyticsClient.cs index d339b38b9..3013f2d50 100644 --- a/algoliasearch/Clients/AnalyticsClient.cs +++ b/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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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. 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) + /// Number of items to return. (optional, default to 10) + /// Position of the first item to return. (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.