Skip to content

Commit 11ae5ea

Browse files
algolia-botfebeckshortcuts
committed
docs(analytics): constrain pagination only to limit query parameter (generated)
algolia/api-clients-automation#4012 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Fernando Beck <[email protected]> Co-authored-by: shortcuts <[email protected]>
1 parent 686cdfb commit 11ae5ea

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -414,8 +414,8 @@ public class AnalyticsClient(
414414
* @param index Index name.
415415
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
416416
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
417-
* @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
418-
* @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)
417+
* @param limit Number of items to return. (default to 10)
418+
* @param offset Position of the first item to return. (default to 0)
419419
* @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/).
420420
* @param requestOptions additional request configuration.
421421
*/
@@ -447,8 +447,8 @@ public class AnalyticsClient(
447447
* @param index Index name.
448448
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
449449
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
450-
* @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
451-
* @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)
450+
* @param limit Number of items to return. (default to 10)
451+
* @param offset Position of the first item to return. (default to 0)
452452
* @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/).
453453
* @param requestOptions additional request configuration.
454454
*/
@@ -503,8 +503,8 @@ public class AnalyticsClient(
503503
* @param index Index name.
504504
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
505505
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
506-
* @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
507-
* @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)
506+
* @param limit Number of items to return. (default to 10)
507+
* @param offset Position of the first item to return. (default to 0)
508508
* @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/).
509509
* @param requestOptions additional request configuration.
510510
*/
@@ -537,8 +537,8 @@ public class AnalyticsClient(
537537
* @param search Search query.
538538
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
539539
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
540-
* @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
541-
* @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)
540+
* @param limit Number of items to return. (default to 10)
541+
* @param offset Position of the first item to return. (default to 0)
542542
* @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/).
543543
* @param requestOptions additional request configuration.
544544
*/
@@ -573,8 +573,8 @@ public class AnalyticsClient(
573573
* @param search Search query.
574574
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
575575
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
576-
* @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
577-
* @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)
576+
* @param limit Number of items to return. (default to 10)
577+
* @param offset Position of the first item to return. (default to 0)
578578
* @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/).
579579
* @param requestOptions additional request configuration.
580580
*/
@@ -609,8 +609,8 @@ public class AnalyticsClient(
609609
* @param search Search query.
610610
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
611611
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
612-
* @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
613-
* @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)
612+
* @param limit Number of items to return. (default to 10)
613+
* @param offset Position of the first item to return. (default to 0)
614614
* @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/).
615615
* @param requestOptions additional request configuration.
616616
*/
@@ -646,8 +646,8 @@ public class AnalyticsClient(
646646
* @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)
647647
* @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format.
648648
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
649-
* @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
650-
* @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)
649+
* @param limit Number of items to return. (default to 10)
650+
* @param offset Position of the first item to return. (default to 0)
651651
* @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/).
652652
* @param requestOptions additional request configuration.
653653
*/
@@ -686,8 +686,8 @@ public class AnalyticsClient(
686686
* @param endDate End date of the period to analyze, in `YYYY-MM-DD` format.
687687
* @param orderBy Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to searchCount)
688688
* @param direction Sorting direction of the results: ascending or descending. (default to asc)
689-
* @param limit Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
690-
* @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)
689+
* @param limit Number of items to return. (default to 10)
690+
* @param offset Position of the first item to return. (default to 0)
691691
* @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/).
692692
* @param requestOptions additional request configuration.
693693
*/

0 commit comments

Comments
 (0)