@algolia/client-analytics 5.0.0-alpha.106 → 5.0.0-alpha.108

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/dist/client-analytics.cjs +66 -66
  2. package/dist/client-analytics.esm.browser.js +66 -66
  3. package/dist/client-analytics.esm.node.js +66 -66
  4. package/dist/client-analytics.umd.js +2 -2
  5. package/dist/model/clientMethodProps.d.ts +65 -65
  6. package/dist/model/searchNoResultEvent.d.ts +1 -1
  7. package/dist/model/topSearch.d.ts +1 -1
  8. package/dist/model/topSearchWithAnalytics.d.ts +1 -1
  9. package/dist/src/analyticsClient.d.ts +66 -66
  10. package/model/clientMethodProps.ts +65 -65
  11. package/model/searchNoResultEvent.ts +1 -1
  12. package/model/topSearch.ts +1 -1
  13. package/model/topSearchWithAnalytics.ts +1 -1
  14. package/package.json +7 -7
package/dist/src/analyticsClient.d.ts CHANGED
@@ -17,7 +17,7 @@ import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoRes
17
17
  import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
18
18
  import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
19
19
  import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
20
- export declare const apiClientVersion = "5.0.0-alpha.106";
20
+ export declare const apiClientVersion = "5.0.0-alpha.108";
21
21
  export declare const REGIONS: readonly ["de", "us"];
22
22
  export type Region = (typeof REGIONS)[number];
23
23
  export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -88,9 +88,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
88
88
  * - analytics.
89
89
  *
90
90
  * @param getAverageClickPosition - The getAverageClickPosition object.
91
- * @param getAverageClickPosition.index - Index name to target.
92
- * @param getAverageClickPosition.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
93
- * @param getAverageClickPosition.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
91
+ * @param getAverageClickPosition.index - Index name.
92
+ * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
93
+ * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
94
94
  * @param getAverageClickPosition.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
95
95
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
96
96
  */
@@ -102,9 +102,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
102
102
  * - analytics.
103
103
  *
104
104
  * @param getClickPositions - The getClickPositions object.
105
- * @param getClickPositions.index - Index name to target.
106
- * @param getClickPositions.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
107
- * @param getClickPositions.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
105
+ * @param getClickPositions.index - Index name.
106
+ * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
107
+ * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
108
108
  * @param getClickPositions.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
109
109
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
110
110
  */
@@ -116,9 +116,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
116
116
  * - analytics.
117
117
  *
118
118
  * @param getClickThroughRate - The getClickThroughRate object.
119
- * @param getClickThroughRate.index - Index name to target.
120
- * @param getClickThroughRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
121
- * @param getClickThroughRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
119
+ * @param getClickThroughRate.index - Index name.
120
+ * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
121
+ * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
122
122
  * @param getClickThroughRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
123
123
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
124
124
  */
@@ -130,9 +130,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
130
130
  * - analytics.
131
131
  *
132
132
  * @param getConversationRate - The getConversationRate object.
133
- * @param getConversationRate.index - Index name to target.
134
- * @param getConversationRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
135
- * @param getConversationRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
133
+ * @param getConversationRate.index - Index name.
134
+ * @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
135
+ * @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
136
136
  * @param getConversationRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
137
137
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
138
138
  */
@@ -144,9 +144,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
144
144
  * - analytics.
145
145
  *
146
146
  * @param getNoClickRate - The getNoClickRate object.
147
- * @param getNoClickRate.index - Index name to target.
148
- * @param getNoClickRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
149
- * @param getNoClickRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
147
+ * @param getNoClickRate.index - Index name.
148
+ * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
149
+ * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
150
150
  * @param getNoClickRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
151
151
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
152
152
  */
@@ -158,9 +158,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
158
158
  * - analytics.
159
159
  *
160
160
  * @param getNoResultsRate - The getNoResultsRate object.
161
- * @param getNoResultsRate.index - Index name to target.
162
- * @param getNoResultsRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
163
- * @param getNoResultsRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
161
+ * @param getNoResultsRate.index - Index name.
162
+ * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
163
+ * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
164
164
  * @param getNoResultsRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
165
165
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
166
166
  */
@@ -172,9 +172,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
172
172
  * - analytics.
173
173
  *
174
174
  * @param getSearchesCount - The getSearchesCount object.
175
- * @param getSearchesCount.index - Index name to target.
176
- * @param getSearchesCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
177
- * @param getSearchesCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
175
+ * @param getSearchesCount.index - Index name.
176
+ * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
177
+ * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
178
178
  * @param getSearchesCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
179
179
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
180
180
  */
@@ -186,11 +186,11 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
186
186
  * - analytics.
187
187
  *
188
188
  * @param getSearchesNoClicks - The getSearchesNoClicks object.
189
- * @param getSearchesNoClicks.index - Index name to target.
190
- * @param getSearchesNoClicks.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
191
- * @param getSearchesNoClicks.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
192
- * @param getSearchesNoClicks.limit - Number of records to return (page size).
193
- * @param getSearchesNoClicks.offset - Position of the starting record. Used for paging. 0 is the first record.
189
+ * @param getSearchesNoClicks.index - Index name.
190
+ * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
191
+ * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
192
+ * @param getSearchesNoClicks.limit - Number of items to return.
193
+ * @param getSearchesNoClicks.offset - Position of the first item to return.
194
194
  * @param getSearchesNoClicks.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
195
195
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
196
196
  */
@@ -202,11 +202,11 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
202
202
  * - analytics.
203
203
  *
204
204
  * @param getSearchesNoResults - The getSearchesNoResults object.
205
- * @param getSearchesNoResults.index - Index name to target.
206
- * @param getSearchesNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
207
- * @param getSearchesNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
208
- * @param getSearchesNoResults.limit - Number of records to return (page size).
209
- * @param getSearchesNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
205
+ * @param getSearchesNoResults.index - Index name.
206
+ * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
207
+ * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
208
+ * @param getSearchesNoResults.limit - Number of items to return.
209
+ * @param getSearchesNoResults.offset - Position of the first item to return.
210
210
  * @param getSearchesNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
211
211
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
212
212
  */
@@ -218,7 +218,7 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
218
218
  * - analytics.
219
219
  *
220
220
  * @param getStatus - The getStatus object.
221
- * @param getStatus.index - Index name to target.
221
+ * @param getStatus.index - Index name.
222
222
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
223
223
  */
224
224
  getStatus({ index }: GetStatusProps, requestOptions?: RequestOptions): Promise<GetStatusResponse>;
@@ -229,11 +229,11 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
229
229
  * - analytics.
230
230
  *
231
231
  * @param getTopCountries - The getTopCountries object.
232
- * @param getTopCountries.index - Index name to target.
233
- * @param getTopCountries.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
234
- * @param getTopCountries.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
235
- * @param getTopCountries.limit - Number of records to return (page size).
236
- * @param getTopCountries.offset - Position of the starting record. Used for paging. 0 is the first record.
232
+ * @param getTopCountries.index - Index name.
233
+ * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
234
+ * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
235
+ * @param getTopCountries.limit - Number of items to return.
236
+ * @param getTopCountries.offset - Position of the first item to return.
237
237
  * @param getTopCountries.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
238
238
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
239
239
  */
@@ -245,12 +245,12 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
245
245
  * - analytics.
246
246
  *
247
247
  * @param getTopFilterAttributes - The getTopFilterAttributes object.
248
- * @param getTopFilterAttributes.index - Index name to target.
248
+ * @param getTopFilterAttributes.index - Index name.
249
249
  * @param getTopFilterAttributes.search - User query.
250
- * @param getTopFilterAttributes.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
251
- * @param getTopFilterAttributes.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
252
- * @param getTopFilterAttributes.limit - Number of records to return (page size).
253
- * @param getTopFilterAttributes.offset - Position of the starting record. Used for paging. 0 is the first record.
250
+ * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
251
+ * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
252
+ * @param getTopFilterAttributes.limit - Number of items to return.
253
+ * @param getTopFilterAttributes.offset - Position of the first item to return.
254
254
  * @param getTopFilterAttributes.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
255
255
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
256
256
  */
@@ -263,12 +263,12 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
263
263
  *
264
264
  * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
265
265
  * @param getTopFilterForAttribute.attribute - Attribute name.
266
- * @param getTopFilterForAttribute.index - Index name to target.
266
+ * @param getTopFilterForAttribute.index - Index name.
267
267
  * @param getTopFilterForAttribute.search - User query.
268
- * @param getTopFilterForAttribute.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
269
- * @param getTopFilterForAttribute.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
270
- * @param getTopFilterForAttribute.limit - Number of records to return (page size).
271
- * @param getTopFilterForAttribute.offset - Position of the starting record. Used for paging. 0 is the first record.
268
+ * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
269
+ * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
270
+ * @param getTopFilterForAttribute.limit - Number of items to return.
271
+ * @param getTopFilterForAttribute.offset - Position of the first item to return.
272
272
  * @param getTopFilterForAttribute.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
273
273
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
274
274
  */
@@ -280,12 +280,12 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
280
280
  * - analytics.
281
281
  *
282
282
  * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
283
- * @param getTopFiltersNoResults.index - Index name to target.
283
+ * @param getTopFiltersNoResults.index - Index name.
284
284
  * @param getTopFiltersNoResults.search - User query.
285
- * @param getTopFiltersNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
286
- * @param getTopFiltersNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
287
- * @param getTopFiltersNoResults.limit - Number of records to return (page size).
288
- * @param getTopFiltersNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
285
+ * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
286
+ * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
287
+ * @param getTopFiltersNoResults.limit - Number of items to return.
288
+ * @param getTopFiltersNoResults.offset - Position of the first item to return.
289
289
  * @param getTopFiltersNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
290
290
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
291
291
  */
@@ -297,13 +297,13 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
297
297
  * - analytics.
298
298
  *
299
299
  * @param getTopHits - The getTopHits object.
300
- * @param getTopHits.index - Index name to target.
300
+ * @param getTopHits.index - Index name.
301
301
  * @param getTopHits.search - User query.
302
302
  * @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
303
- * @param getTopHits.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
304
- * @param getTopHits.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
305
- * @param getTopHits.limit - Number of records to return (page size).
306
- * @param getTopHits.offset - Position of the starting record. Used for paging. 0 is the first record.
303
+ * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
304
+ * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
305
+ * @param getTopHits.limit - Number of items to return.
306
+ * @param getTopHits.offset - Position of the first item to return.
307
307
  * @param getTopHits.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
308
308
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
309
309
  */
@@ -315,14 +315,14 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
315
315
  * - analytics.
316
316
  *
317
317
  * @param getTopSearches - The getTopSearches object.
318
- * @param getTopSearches.index - Index name to target.
318
+ * @param getTopSearches.index - Index name.
319
319
  * @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
320
- * @param getTopSearches.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
321
- * @param getTopSearches.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
320
+ * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
321
+ * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
322
322
  * @param getTopSearches.orderBy - Reorder the results.
323
323
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
324
- * @param getTopSearches.limit - Number of records to return (page size).
325
- * @param getTopSearches.offset - Position of the starting record. Used for paging. 0 is the first record.
324
+ * @param getTopSearches.limit - Number of items to return.
325
+ * @param getTopSearches.offset - Position of the first item to return.
326
326
  * @param getTopSearches.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
327
327
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
328
328
  */
@@ -334,9 +334,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
334
334
  * - analytics.
335
335
  *
336
336
  * @param getUsersCount - The getUsersCount object.
337
- * @param getUsersCount.index - Index name to target.
338
- * @param getUsersCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
339
- * @param getUsersCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
337
+ * @param getUsersCount.index - Index name.
338
+ * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
339
+ * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
340
340
  * @param getUsersCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
341
341
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
342
342
  */