@algolia/client-analytics 5.9.0 → 5.10.0
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.
- package/README.md +4 -4
- package/dist/browser.d.ts +33 -33
- package/dist/builds/browser.js +17 -17
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +1 -1
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +1 -1
- package/dist/builds/fetch.js +17 -17
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +17 -17
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +17 -17
- package/dist/builds/node.js.map +1 -1
- package/dist/fetch.d.ts +33 -33
- package/dist/node.d.cts +33 -33
- package/dist/node.d.ts +33 -33
- package/dist/src/analyticsClient.cjs +17 -17
- package/dist/src/analyticsClient.cjs.map +1 -1
- package/dist/src/analyticsClient.js +17 -17
- package/dist/src/analyticsClient.js.map +1 -1
- package/package.json +6 -7
- package/model/clickPosition.ts +0 -16
- package/model/clientMethodProps.ts +0 -605
- package/model/currencyCode.ts +0 -16
- package/model/dailyAddToCartRates.ts +0 -23
- package/model/dailyAverageClicks.ts +0 -18
- package/model/dailyClickThroughRates.ts +0 -23
- package/model/dailyConversionRates.ts +0 -23
- package/model/dailyNoClickRates.ts +0 -23
- package/model/dailyNoResultsRates.ts +0 -23
- package/model/dailyPurchaseRates.ts +0 -23
- package/model/dailyRevenue.ts +0 -15
- package/model/dailySearches.ts +0 -13
- package/model/dailySearchesNoClicks.ts +0 -18
- package/model/dailySearchesNoResults.ts +0 -18
- package/model/dailyUsers.ts +0 -13
- package/model/direction.ts +0 -3
- package/model/errorBase.ts +0 -8
- package/model/getAddToCartRateResponse.ts +0 -25
- package/model/getAverageClickPositionResponse.ts +0 -20
- package/model/getClickPositionsResponse.ts +0 -10
- package/model/getClickThroughRateResponse.ts +0 -25
- package/model/getConversionRateResponse.ts +0 -25
- package/model/getNoClickRateResponse.ts +0 -25
- package/model/getNoResultsRateResponse.ts +0 -25
- package/model/getPurchaseRateResponse.ts +0 -25
- package/model/getRevenue.ts +0 -16
- package/model/getSearchesCountResponse.ts +0 -15
- package/model/getSearchesNoClicksResponse.ts +0 -10
- package/model/getSearchesNoResultsResponse.ts +0 -10
- package/model/getStatusResponse.ts +0 -8
- package/model/getTopCountriesResponse.ts +0 -10
- package/model/getTopFilterAttribute.ts +0 -13
- package/model/getTopFilterAttributesResponse.ts +0 -10
- package/model/getTopFilterForAttribute.ts +0 -22
- package/model/getTopFilterForAttributeResponse.ts +0 -10
- package/model/getTopFiltersNoResultsResponse.ts +0 -10
- package/model/getTopFiltersNoResultsValue.ts +0 -17
- package/model/getTopFiltersNoResultsValues.ts +0 -15
- package/model/getTopHitsResponse.ts +0 -7
- package/model/getTopSearchesResponse.ts +0 -10
- package/model/getUsersCountResponse.ts +0 -15
- package/model/index.ts +0 -58
- package/model/operator.ts +0 -6
- package/model/orderBy.ts +0 -6
- package/model/topCountry.ts +0 -13
- package/model/topHit.ts +0 -13
- package/model/topHitWithAnalytics.ts +0 -38
- package/model/topHitWithRevenueAnalytics.ts +0 -65
- package/model/topHitsResponse.ts +0 -10
- package/model/topHitsResponseWithAnalytics.ts +0 -10
- package/model/topHitsResponseWithRevenueAnalytics.ts +0 -10
- package/model/topSearch.ts +0 -18
- package/model/topSearchWithAnalytics.ts +0 -55
- package/model/topSearchWithRevenueAnalytics.ts +0 -81
- package/model/topSearchesResponse.ts +0 -10
- package/model/topSearchesResponseWithAnalytics.ts +0 -10
- package/model/topSearchesResponseWithRevenueAnalytics.ts +0 -10
package/README.md
CHANGED
|
@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
|
|
|
41
41
|
### With a package manager
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
yarn add @algolia/client-analytics@5.
|
|
44
|
+
yarn add @algolia/client-analytics@5.10.0
|
|
45
45
|
# or
|
|
46
|
-
npm install @algolia/client-analytics@5.
|
|
46
|
+
npm install @algolia/client-analytics@5.10.0
|
|
47
47
|
# or
|
|
48
|
-
pnpm add @algolia/client-analytics@5.
|
|
48
|
+
pnpm add @algolia/client-analytics@5.10.0
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
### Without a package manager
|
|
@@ -53,7 +53,7 @@ pnpm add @algolia/client-analytics@5.9.0
|
|
|
53
53
|
Add the following JavaScript snippet to the <head> of your website:
|
|
54
54
|
|
|
55
55
|
```html
|
|
56
|
-
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-analytics@5.
|
|
56
|
+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-analytics@5.10.0/dist/builds/browser.umd.js"></script>
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
### Usage
|
package/dist/browser.d.ts
CHANGED
|
@@ -1075,11 +1075,11 @@ type GetSearchesNoClicksProps = {
|
|
|
1075
1075
|
*/
|
|
1076
1076
|
endDate?: string;
|
|
1077
1077
|
/**
|
|
1078
|
-
* Number of items to return.
|
|
1078
|
+
* Number of items to return.
|
|
1079
1079
|
*/
|
|
1080
1080
|
limit?: number;
|
|
1081
1081
|
/**
|
|
1082
|
-
* Position of the first item to return.
|
|
1082
|
+
* Position of the first item to return.
|
|
1083
1083
|
*/
|
|
1084
1084
|
offset?: number;
|
|
1085
1085
|
/**
|
|
@@ -1104,11 +1104,11 @@ type GetSearchesNoResultsProps = {
|
|
|
1104
1104
|
*/
|
|
1105
1105
|
endDate?: string;
|
|
1106
1106
|
/**
|
|
1107
|
-
* Number of items to return.
|
|
1107
|
+
* Number of items to return.
|
|
1108
1108
|
*/
|
|
1109
1109
|
limit?: number;
|
|
1110
1110
|
/**
|
|
1111
|
-
* Position of the first item to return.
|
|
1111
|
+
* Position of the first item to return.
|
|
1112
1112
|
*/
|
|
1113
1113
|
offset?: number;
|
|
1114
1114
|
/**
|
|
@@ -1142,11 +1142,11 @@ type GetTopCountriesProps = {
|
|
|
1142
1142
|
*/
|
|
1143
1143
|
endDate?: string;
|
|
1144
1144
|
/**
|
|
1145
|
-
* Number of items to return.
|
|
1145
|
+
* Number of items to return.
|
|
1146
1146
|
*/
|
|
1147
1147
|
limit?: number;
|
|
1148
1148
|
/**
|
|
1149
|
-
* Position of the first item to return.
|
|
1149
|
+
* Position of the first item to return.
|
|
1150
1150
|
*/
|
|
1151
1151
|
offset?: number;
|
|
1152
1152
|
/**
|
|
@@ -1175,11 +1175,11 @@ type GetTopFilterAttributesProps = {
|
|
|
1175
1175
|
*/
|
|
1176
1176
|
endDate?: string;
|
|
1177
1177
|
/**
|
|
1178
|
-
* Number of items to return.
|
|
1178
|
+
* Number of items to return.
|
|
1179
1179
|
*/
|
|
1180
1180
|
limit?: number;
|
|
1181
1181
|
/**
|
|
1182
|
-
* Position of the first item to return.
|
|
1182
|
+
* Position of the first item to return.
|
|
1183
1183
|
*/
|
|
1184
1184
|
offset?: number;
|
|
1185
1185
|
/**
|
|
@@ -1212,11 +1212,11 @@ type GetTopFilterForAttributeProps = {
|
|
|
1212
1212
|
*/
|
|
1213
1213
|
endDate?: string;
|
|
1214
1214
|
/**
|
|
1215
|
-
* Number of items to return.
|
|
1215
|
+
* Number of items to return.
|
|
1216
1216
|
*/
|
|
1217
1217
|
limit?: number;
|
|
1218
1218
|
/**
|
|
1219
|
-
* Position of the first item to return.
|
|
1219
|
+
* Position of the first item to return.
|
|
1220
1220
|
*/
|
|
1221
1221
|
offset?: number;
|
|
1222
1222
|
/**
|
|
@@ -1245,11 +1245,11 @@ type GetTopFiltersNoResultsProps = {
|
|
|
1245
1245
|
*/
|
|
1246
1246
|
endDate?: string;
|
|
1247
1247
|
/**
|
|
1248
|
-
* Number of items to return.
|
|
1248
|
+
* Number of items to return.
|
|
1249
1249
|
*/
|
|
1250
1250
|
limit?: number;
|
|
1251
1251
|
/**
|
|
1252
|
-
* Position of the first item to return.
|
|
1252
|
+
* Position of the first item to return.
|
|
1253
1253
|
*/
|
|
1254
1254
|
offset?: number;
|
|
1255
1255
|
/**
|
|
@@ -1286,11 +1286,11 @@ type GetTopHitsProps = {
|
|
|
1286
1286
|
*/
|
|
1287
1287
|
endDate?: string;
|
|
1288
1288
|
/**
|
|
1289
|
-
* Number of items to return.
|
|
1289
|
+
* Number of items to return.
|
|
1290
1290
|
*/
|
|
1291
1291
|
limit?: number;
|
|
1292
1292
|
/**
|
|
1293
|
-
* Position of the first item to return.
|
|
1293
|
+
* Position of the first item to return.
|
|
1294
1294
|
*/
|
|
1295
1295
|
offset?: number;
|
|
1296
1296
|
/**
|
|
@@ -1331,11 +1331,11 @@ type GetTopSearchesProps = {
|
|
|
1331
1331
|
*/
|
|
1332
1332
|
direction?: Direction;
|
|
1333
1333
|
/**
|
|
1334
|
-
* Number of items to return.
|
|
1334
|
+
* Number of items to return.
|
|
1335
1335
|
*/
|
|
1336
1336
|
limit?: number;
|
|
1337
1337
|
/**
|
|
1338
|
-
* Position of the first item to return.
|
|
1338
|
+
* Position of the first item to return.
|
|
1339
1339
|
*/
|
|
1340
1340
|
offset?: number;
|
|
1341
1341
|
/**
|
|
@@ -1365,7 +1365,7 @@ type GetUsersCountProps = {
|
|
|
1365
1365
|
tags?: string;
|
|
1366
1366
|
};
|
|
1367
1367
|
|
|
1368
|
-
declare const apiClientVersion = "5.
|
|
1368
|
+
declare const apiClientVersion = "5.10.0";
|
|
1369
1369
|
declare const REGIONS: readonly ["de", "us"];
|
|
1370
1370
|
type Region = (typeof REGIONS)[number];
|
|
1371
1371
|
type RegionOptions = {
|
|
@@ -1574,8 +1574,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
1574
1574
|
* @param getSearchesNoClicks.index - Index name.
|
|
1575
1575
|
* @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1576
1576
|
* @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1577
|
-
* @param getSearchesNoClicks.limit - Number of items to return.
|
|
1578
|
-
* @param getSearchesNoClicks.offset - Position of the first item to return.
|
|
1577
|
+
* @param getSearchesNoClicks.limit - Number of items to return.
|
|
1578
|
+
* @param getSearchesNoClicks.offset - Position of the first item to return.
|
|
1579
1579
|
* @param getSearchesNoClicks.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/).
|
|
1580
1580
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1581
1581
|
*/
|
|
@@ -1589,8 +1589,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
1589
1589
|
* @param getSearchesNoResults.index - Index name.
|
|
1590
1590
|
* @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1591
1591
|
* @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1592
|
-
* @param getSearchesNoResults.limit - Number of items to return.
|
|
1593
|
-
* @param getSearchesNoResults.offset - Position of the first item to return.
|
|
1592
|
+
* @param getSearchesNoResults.limit - Number of items to return.
|
|
1593
|
+
* @param getSearchesNoResults.offset - Position of the first item to return.
|
|
1594
1594
|
* @param getSearchesNoResults.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/).
|
|
1595
1595
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1596
1596
|
*/
|
|
@@ -1614,8 +1614,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
1614
1614
|
* @param getTopCountries.index - Index name.
|
|
1615
1615
|
* @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1616
1616
|
* @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1617
|
-
* @param getTopCountries.limit - Number of items to return.
|
|
1618
|
-
* @param getTopCountries.offset - Position of the first item to return.
|
|
1617
|
+
* @param getTopCountries.limit - Number of items to return.
|
|
1618
|
+
* @param getTopCountries.offset - Position of the first item to return.
|
|
1619
1619
|
* @param getTopCountries.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/).
|
|
1620
1620
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1621
1621
|
*/
|
|
@@ -1630,8 +1630,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
1630
1630
|
* @param getTopFilterAttributes.search - Search query.
|
|
1631
1631
|
* @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1632
1632
|
* @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1633
|
-
* @param getTopFilterAttributes.limit - Number of items to return.
|
|
1634
|
-
* @param getTopFilterAttributes.offset - Position of the first item to return.
|
|
1633
|
+
* @param getTopFilterAttributes.limit - Number of items to return.
|
|
1634
|
+
* @param getTopFilterAttributes.offset - Position of the first item to return.
|
|
1635
1635
|
* @param getTopFilterAttributes.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/).
|
|
1636
1636
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1637
1637
|
*/
|
|
@@ -1647,8 +1647,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
1647
1647
|
* @param getTopFilterForAttribute.search - Search query.
|
|
1648
1648
|
* @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1649
1649
|
* @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1650
|
-
* @param getTopFilterForAttribute.limit - Number of items to return.
|
|
1651
|
-
* @param getTopFilterForAttribute.offset - Position of the first item to return.
|
|
1650
|
+
* @param getTopFilterForAttribute.limit - Number of items to return.
|
|
1651
|
+
* @param getTopFilterForAttribute.offset - Position of the first item to return.
|
|
1652
1652
|
* @param getTopFilterForAttribute.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/).
|
|
1653
1653
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1654
1654
|
*/
|
|
@@ -1663,8 +1663,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
1663
1663
|
* @param getTopFiltersNoResults.search - Search query.
|
|
1664
1664
|
* @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1665
1665
|
* @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1666
|
-
* @param getTopFiltersNoResults.limit - Number of items to return.
|
|
1667
|
-
* @param getTopFiltersNoResults.offset - Position of the first item to return.
|
|
1666
|
+
* @param getTopFiltersNoResults.limit - Number of items to return.
|
|
1667
|
+
* @param getTopFiltersNoResults.offset - Position of the first item to return.
|
|
1668
1668
|
* @param getTopFiltersNoResults.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/).
|
|
1669
1669
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1670
1670
|
*/
|
|
@@ -1681,8 +1681,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
1681
1681
|
* @param getTopHits.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.
|
|
1682
1682
|
* @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1683
1683
|
* @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1684
|
-
* @param getTopHits.limit - Number of items to return.
|
|
1685
|
-
* @param getTopHits.offset - Position of the first item to return.
|
|
1684
|
+
* @param getTopHits.limit - Number of items to return.
|
|
1685
|
+
* @param getTopHits.offset - Position of the first item to return.
|
|
1686
1686
|
* @param getTopHits.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/).
|
|
1687
1687
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1688
1688
|
*/
|
|
@@ -1700,8 +1700,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
1700
1700
|
* @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1701
1701
|
* @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
|
|
1702
1702
|
* @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
|
|
1703
|
-
* @param getTopSearches.limit - Number of items to return.
|
|
1704
|
-
* @param getTopSearches.offset - Position of the first item to return.
|
|
1703
|
+
* @param getTopSearches.limit - Number of items to return.
|
|
1704
|
+
* @param getTopSearches.offset - Position of the first item to return.
|
|
1705
1705
|
* @param getTopSearches.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/).
|
|
1706
1706
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1707
1707
|
*/
|
package/dist/builds/browser.js
CHANGED
|
@@ -12,7 +12,7 @@ import {
|
|
|
12
12
|
|
|
13
13
|
// src/analyticsClient.ts
|
|
14
14
|
import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
|
|
15
|
-
var apiClientVersion = "5.
|
|
15
|
+
var apiClientVersion = "5.10.0";
|
|
16
16
|
var REGIONS = ["de", "us"];
|
|
17
17
|
function getDefaultHosts(region) {
|
|
18
18
|
const url = !region ? "analytics.algolia.com" : "analytics.{region}.algolia.com".replace("{region}", region);
|
|
@@ -576,8 +576,8 @@ function createAnalyticsClient({
|
|
|
576
576
|
* @param getSearchesNoClicks.index - Index name.
|
|
577
577
|
* @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
578
578
|
* @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
579
|
-
* @param getSearchesNoClicks.limit - Number of items to return.
|
|
580
|
-
* @param getSearchesNoClicks.offset - Position of the first item to return.
|
|
579
|
+
* @param getSearchesNoClicks.limit - Number of items to return.
|
|
580
|
+
* @param getSearchesNoClicks.offset - Position of the first item to return.
|
|
581
581
|
* @param getSearchesNoClicks.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/).
|
|
582
582
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
583
583
|
*/
|
|
@@ -623,8 +623,8 @@ function createAnalyticsClient({
|
|
|
623
623
|
* @param getSearchesNoResults.index - Index name.
|
|
624
624
|
* @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
625
625
|
* @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
626
|
-
* @param getSearchesNoResults.limit - Number of items to return.
|
|
627
|
-
* @param getSearchesNoResults.offset - Position of the first item to return.
|
|
626
|
+
* @param getSearchesNoResults.limit - Number of items to return.
|
|
627
|
+
* @param getSearchesNoResults.offset - Position of the first item to return.
|
|
628
628
|
* @param getSearchesNoResults.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/).
|
|
629
629
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
630
630
|
*/
|
|
@@ -697,8 +697,8 @@ function createAnalyticsClient({
|
|
|
697
697
|
* @param getTopCountries.index - Index name.
|
|
698
698
|
* @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
699
699
|
* @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
700
|
-
* @param getTopCountries.limit - Number of items to return.
|
|
701
|
-
* @param getTopCountries.offset - Position of the first item to return.
|
|
700
|
+
* @param getTopCountries.limit - Number of items to return.
|
|
701
|
+
* @param getTopCountries.offset - Position of the first item to return.
|
|
702
702
|
* @param getTopCountries.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/).
|
|
703
703
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
704
704
|
*/
|
|
@@ -745,8 +745,8 @@ function createAnalyticsClient({
|
|
|
745
745
|
* @param getTopFilterAttributes.search - Search query.
|
|
746
746
|
* @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
747
747
|
* @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
748
|
-
* @param getTopFilterAttributes.limit - Number of items to return.
|
|
749
|
-
* @param getTopFilterAttributes.offset - Position of the first item to return.
|
|
748
|
+
* @param getTopFilterAttributes.limit - Number of items to return.
|
|
749
|
+
* @param getTopFilterAttributes.offset - Position of the first item to return.
|
|
750
750
|
* @param getTopFilterAttributes.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/).
|
|
751
751
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
752
752
|
*/
|
|
@@ -797,8 +797,8 @@ function createAnalyticsClient({
|
|
|
797
797
|
* @param getTopFilterForAttribute.search - Search query.
|
|
798
798
|
* @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
799
799
|
* @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
800
|
-
* @param getTopFilterForAttribute.limit - Number of items to return.
|
|
801
|
-
* @param getTopFilterForAttribute.offset - Position of the first item to return.
|
|
800
|
+
* @param getTopFilterForAttribute.limit - Number of items to return.
|
|
801
|
+
* @param getTopFilterForAttribute.offset - Position of the first item to return.
|
|
802
802
|
* @param getTopFilterForAttribute.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/).
|
|
803
803
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
804
804
|
*/
|
|
@@ -851,8 +851,8 @@ function createAnalyticsClient({
|
|
|
851
851
|
* @param getTopFiltersNoResults.search - Search query.
|
|
852
852
|
* @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
853
853
|
* @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
854
|
-
* @param getTopFiltersNoResults.limit - Number of items to return.
|
|
855
|
-
* @param getTopFiltersNoResults.offset - Position of the first item to return.
|
|
854
|
+
* @param getTopFiltersNoResults.limit - Number of items to return.
|
|
855
|
+
* @param getTopFiltersNoResults.offset - Position of the first item to return.
|
|
856
856
|
* @param getTopFiltersNoResults.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/).
|
|
857
857
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
858
858
|
*/
|
|
@@ -904,8 +904,8 @@ function createAnalyticsClient({
|
|
|
904
904
|
* @param getTopHits.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.
|
|
905
905
|
* @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
906
906
|
* @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
907
|
-
* @param getTopHits.limit - Number of items to return.
|
|
908
|
-
* @param getTopHits.offset - Position of the first item to return.
|
|
907
|
+
* @param getTopHits.limit - Number of items to return.
|
|
908
|
+
* @param getTopHits.offset - Position of the first item to return.
|
|
909
909
|
* @param getTopHits.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/).
|
|
910
910
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
911
911
|
*/
|
|
@@ -964,8 +964,8 @@ function createAnalyticsClient({
|
|
|
964
964
|
* @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
965
965
|
* @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
|
|
966
966
|
* @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
|
|
967
|
-
* @param getTopSearches.limit - Number of items to return.
|
|
968
|
-
* @param getTopSearches.offset - Position of the first item to return.
|
|
967
|
+
* @param getTopSearches.limit - Number of items to return.
|
|
968
|
+
* @param getTopSearches.offset - Position of the first item to return.
|
|
969
969
|
* @param getTopSearches.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/).
|
|
970
970
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
971
971
|
*/
|