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
@algolia-bot @febeck @shortcuts
3 people committed Oct 21, 2024
1 parent 3fcacbd commit e27049b
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions lib/Api/AnalyticsClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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 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 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
*
Expand Down Expand Up @@ -801,8 +801,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. 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 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 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
*
Expand Down Expand Up @@ -890,8 +890,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. 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 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 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
*
Expand Down Expand Up @@ -948,8 +948,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. 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 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 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
*
Expand Down Expand Up @@ -1011,8 +1011,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. 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 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 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
*
Expand Down Expand Up @@ -1088,8 +1088,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. 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 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 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
*
Expand Down Expand Up @@ -1152,8 +1152,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. 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 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 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
*
Expand Down Expand Up @@ -1225,8 +1225,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. 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 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 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
*
Expand Down

0 comments on commit e27049b

Please sign in to comment.