@@ -128,7 +128,7 @@ paths:
128
128
/{path} :
129
129
get :
130
130
operationId : customGet
131
- summary : Send requests to the Algolia REST API.
131
+ summary : Send requests to the Algolia REST API
132
132
description : This method allow you to send requests to the Algolia REST API.
133
133
parameters :
134
134
- $ref : ' #/components/parameters/PathInPath'
@@ -340,7 +340,7 @@ paths:
340
340
application/json :
341
341
schema :
342
342
type : object
343
- summary : Send requests to the Algolia REST API.
343
+ summary : Send requests to the Algolia REST API
344
344
description : This method allow you to send requests to the Algolia REST API.
345
345
parameters :
346
346
- $ref : ' #/components/parameters/PathInPath'
@@ -552,7 +552,7 @@ paths:
552
552
application/json :
553
553
schema :
554
554
type : object
555
- summary : Send requests to the Algolia REST API.
555
+ summary : Send requests to the Algolia REST API
556
556
description : This method allow you to send requests to the Algolia REST API.
557
557
parameters :
558
558
- $ref : ' #/components/parameters/PathInPath'
@@ -758,7 +758,7 @@ paths:
758
758
_ = try await client.customPut(path: "test/minimal")
759
759
delete :
760
760
operationId : customDelete
761
- summary : Send requests to the Algolia REST API.
761
+ summary : Send requests to the Algolia REST API
762
762
description : This method allow you to send requests to the Algolia REST API.
763
763
parameters :
764
764
- $ref : ' #/components/parameters/PathInPath'
@@ -975,7 +975,7 @@ paths:
975
975
operationId : getTopSearches
976
976
x-acl :
977
977
- analytics
978
- summary : Retrieve top searches.
978
+ summary : Retrieve top searches
979
979
description : Returns the most popular search terms.
980
980
parameters :
981
981
- $ref : ' #/components/parameters/Index'
@@ -1202,7 +1202,7 @@ paths:
1202
1202
operationId : getSearchesCount
1203
1203
x-acl :
1204
1204
- analytics
1205
- summary : Retrieve number of searches.
1205
+ summary : Retrieve number of searches
1206
1206
description : >
1207
1207
Retrieves the number of searches within a time range, including a daily
1208
1208
breakdown.
@@ -1452,7 +1452,7 @@ paths:
1452
1452
operationId : getSearchesNoResults
1453
1453
x-acl :
1454
1454
- analytics
1455
- summary : Retrieve top searches without results.
1455
+ summary : Retrieve top searches without results
1456
1456
description : Retrieves the most popular searches that didn't return any results.
1457
1457
parameters :
1458
1458
- $ref : ' #/components/parameters/Index'
@@ -1704,7 +1704,7 @@ paths:
1704
1704
operationId : getSearchesNoClicks
1705
1705
x-acl :
1706
1706
- analytics
1707
- summary : Retrieve top searches without clicks.
1707
+ summary : Retrieve top searches without clicks
1708
1708
description : >-
1709
1709
Retrieves the most popular searches that didn't lead to any clicks, from
1710
1710
the 1,000 most frequent searches.
@@ -1961,7 +1961,7 @@ paths:
1961
1961
operationId : getNoResultsRate
1962
1962
x-acl :
1963
1963
- analytics
1964
- summary : Retrieve no results rate.
1964
+ summary : Retrieve no results rate
1965
1965
description : >
1966
1966
Retrieves the fraction of searches that didn't return any results within
1967
1967
a time range, including a daily breakdown.
@@ -2223,7 +2223,7 @@ paths:
2223
2223
operationId : getNoClickRate
2224
2224
x-acl :
2225
2225
- analytics
2226
- summary : Retrieve no click rate.
2226
+ summary : Retrieve no click rate
2227
2227
description : >
2228
2228
Retrieves the fraction of searches that didn't lead to any click within
2229
2229
a time range, including a daily breakdown.
@@ -2485,7 +2485,7 @@ paths:
2485
2485
operationId : getTopHits
2486
2486
x-acl :
2487
2487
- analytics
2488
- summary : Retrieve top search results.
2488
+ summary : Retrieve top search results
2489
2489
description : Retrieves the object IDs of the most frequent search results.
2490
2490
parameters :
2491
2491
- $ref : ' #/components/parameters/Index'
@@ -2710,7 +2710,7 @@ paths:
2710
2710
operationId : getUsersCount
2711
2711
x-acl :
2712
2712
- analytics
2713
- summary : Retrieve number of users.
2713
+ summary : Retrieve number of users
2714
2714
description : >
2715
2715
Retrieves the number of unique users within a time range, including a
2716
2716
daily breakdown.
@@ -2974,7 +2974,7 @@ paths:
2974
2974
operationId : getTopFilterAttributes
2975
2975
x-acl :
2976
2976
- analytics
2977
- summary : Retrieve top filters.
2977
+ summary : Retrieve top filters
2978
2978
description : >
2979
2979
Retrieves the most frequently used filter attributes.
2980
2980
@@ -3209,7 +3209,7 @@ paths:
3209
3209
operationId : getTopFilterForAttribute
3210
3210
x-acl :
3211
3211
- analytics
3212
- summary : Retrieve top filter values.
3212
+ summary : Retrieve top filter values
3213
3213
description : >
3214
3214
Retrieves the most frequent filter (facet) values for a filter
3215
3215
attribute.
@@ -3452,7 +3452,7 @@ paths:
3452
3452
operationId : getTopFiltersNoResults
3453
3453
x-acl :
3454
3454
- analytics
3455
- summary : Retrieve top filters for a search without results.
3455
+ summary : Retrieve top filters for a search without results
3456
3456
description : >
3457
3457
Retrieves the most frequently used filters for a search that didn't
3458
3458
return any results.
@@ -3689,7 +3689,7 @@ paths:
3689
3689
operationId : getTopCountries
3690
3690
x-acl :
3691
3691
- analytics
3692
- summary : Retrieve top countries.
3692
+ summary : Retrieve top countries
3693
3693
description : Retrieves the countries with the most searches to your index.
3694
3694
parameters :
3695
3695
- $ref : ' #/components/parameters/Index'
@@ -3934,7 +3934,7 @@ paths:
3934
3934
operationId : getAverageClickPosition
3935
3935
x-acl :
3936
3936
- analytics
3937
- summary : Retrieve average click position.
3937
+ summary : Retrieve average click position
3938
3938
description : >
3939
3939
Retrieves the average click position of your search results, including a
3940
3940
daily breakdown.
@@ -4202,7 +4202,7 @@ paths:
4202
4202
operationId : getClickPositions
4203
4203
x-acl :
4204
4204
- analytics
4205
- summary : Retrieve click positions.
4205
+ summary : Retrieve click positions
4206
4206
description : >
4207
4207
Retrieves the positions in the search results and their associated
4208
4208
number of clicks.
@@ -4436,7 +4436,7 @@ paths:
4436
4436
operationId : getClickThroughRate
4437
4437
x-acl :
4438
4438
- analytics
4439
- summary : Retrieve click-through rate.
4439
+ summary : Retrieve click-through rate
4440
4440
description : >
4441
4441
Retrieves the click-through rate for all of your searches with at least
4442
4442
one click event, including a daily breakdown
@@ -4704,7 +4704,7 @@ paths:
4704
4704
operationId : getConversionRate
4705
4705
x-acl :
4706
4706
- analytics
4707
- summary : Retrieve conversion rate.
4707
+ summary : Retrieve conversion rate
4708
4708
description : >
4709
4709
Retrieves the conversion rate for all of your searches with at least one
4710
4710
conversion event, including a daily breakdown.
@@ -4966,7 +4966,7 @@ paths:
4966
4966
operationId : getAddToCartRate
4967
4967
x-acl :
4968
4968
- analytics
4969
- summary : Retrieve add-to-cart rate.
4969
+ summary : Retrieve add-to-cart rate
4970
4970
description : >
4971
4971
Retrieves the add-to-cart rate for all of your searches with at least
4972
4972
one add-to-cart event, including a daily breakdown.
@@ -5228,7 +5228,7 @@ paths:
5228
5228
operationId : getPurchaseRate
5229
5229
x-acl :
5230
5230
- analytics
5231
- summary : Retrieve purchase rate.
5231
+ summary : Retrieve purchase rate
5232
5232
description : >
5233
5233
Retrieves the purchase rate for all of your searches with at least one
5234
5234
purchase event, including a daily breakdown.
@@ -5490,7 +5490,7 @@ paths:
5490
5490
operationId : getRevenue
5491
5491
x-acl :
5492
5492
- analytics
5493
- summary : Retrieve revenue data.
5493
+ summary : Retrieve revenue data
5494
5494
description : >
5495
5495
Retrieves revenue-related metrics, such as the total revenue or the
5496
5496
average order value.
@@ -5734,7 +5734,7 @@ paths:
5734
5734
operationId : getStatus
5735
5735
x-acl :
5736
5736
- analytics
5737
- summary : Retrieve update status.
5737
+ summary : Retrieve update status
5738
5738
description : >
5739
5739
Retrieves the time when the Analytics data for the specified index was
5740
5740
last updated.
0 commit comments