Skip to content

Commit

Permalink
docs(analytics): constrain pagination only to limit query parameter (…
Browse files Browse the repository at this point in the history
…generated)

algolia/api-clients-automation#4012

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: shortcuts <vannicattec@gmail.com>
  • Loading branch information
3 people committed Oct 21, 2024
1 parent a989d8c commit 5c7b236
Showing 1 changed file with 16 additions and 24 deletions.
40 changes: 16 additions & 24 deletions src/main/scala/algoliasearch/api/AnalyticsClient.scala
Original file line number Diff line number Diff line change
Expand Up @@ -580,10 +580,9 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* Number of items to return.
* @param offset
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
* retrieved.
* Position of the first item to return.
* @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
Expand Down Expand Up @@ -626,10 +625,9 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* Number of items to return.
* @param offset
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
* retrieved.
* Position of the first item to return.
* @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
Expand Down Expand Up @@ -695,10 +693,9 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* Number of items to return.
* @param offset
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
* retrieved.
* Position of the first item to return.
* @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
Expand Down Expand Up @@ -744,10 +741,9 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* Number of items to return.
* @param offset
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
* retrieved.
* Position of the first item to return.
* @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
Expand Down Expand Up @@ -797,10 +793,9 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* Number of items to return.
* @param offset
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
* retrieved.
* Position of the first item to return.
* @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
Expand Down Expand Up @@ -851,10 +846,9 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* Number of items to return.
* @param offset
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
* retrieved.
* Position of the first item to return.
* @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
Expand Down Expand Up @@ -906,10 +900,9 @@ class AnalyticsClient(
* @param endDate
* End date of the period to analyze, in `YYYY-MM-DD` format.
* @param limit
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* Number of items to return.
* @param offset
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
* retrieved.
* Position of the first item to return.
* @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
Expand Down Expand Up @@ -968,10 +961,9 @@ class AnalyticsClient(
* @param direction
* Sorting direction of the results: ascending or descending.
* @param limit
* Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
* Number of items to return.
* @param offset
* Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be
* retrieved.
* Position of the first item to return.
* @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
Expand Down

0 comments on commit 5c7b236

Please sign in to comment.