algolia · shortcuts · Jan 17, 2024 · Dec 14, 2023 · Jan 17, 2024 · Jan 17, 2024
@@ -2,6 +2,8 @@ get:
   tags:
     - abtest
   operationId: getABTest
+  x-acl:
+    - analytics
   summary: Get A/B test details.
   description: >
     Get specific details for an A/B test.
@@ -29,6 +31,8 @@ delete:
   tags:
     - abtest
   operationId: deleteABTest
+  x-acl:
+    - editSettings
   summary: Delete an A/B test.
   description: >
     Delete an A/B test.

@@ -2,6 +2,8 @@ post:
   tags:
     - abtest
   operationId: addABTests
+  x-acl:
+    - editSettings
   summary: Create an A/B test.
   description: Creates an A/B test.
   requestBody:
@@ -48,6 +50,8 @@ get:
   tags:
     - abtest
   operationId: listABTests
+  x-acl:
+    - analytics
   summary: List all A/B tests.
   description: List all A/B tests.
   parameters:

@@ -2,11 +2,13 @@ post:
   tags:
     - abtest
   operationId: stopABTest
+  x-acl:
+    - editSettings
   summary: Stop an A/B test.
   description: >
     If stopped, the test is over and can't be restarted.
     There is now only one index, receiving 100% of all search requests.
-    
+
     The data gathered for stopped A/B tests is retained.
 
     To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

@@ -2,6 +2,8 @@ get:
   tags:
     - click
   operationId: getAverageClickPosition
+  x-acl:
+    - analytics
   summary: Get average click position.
   description: >
     Return the average click position for the complete time range and for individual days.

@@ -2,6 +2,8 @@ get:
   tags:
     - click
   operationId: getClickPositions
+  x-acl:
+    - analytics
   summary: Get click positions.
   description: |
     Show the number of clicks events and their associated position in the search results.
@@ -46,7 +48,7 @@ get:
                         - For positions 11 to 20, all click events are grouped
                         - For positions 21 and up, all click events are grouped.
                       type: array
-                      example: [10,10]
+                      example: [10, 10]
                       items:
                         type: integer
                     clickCount:

@@ -2,6 +2,8 @@ get:
   tags:
     - click
   operationId: getClickThroughRate
+  x-acl:
+    - analytics
   summary: Get click-through rate (CTR).
   description: Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - click
   operationId: getConversationRate
+  x-acl:
+    - analytics
   summary: Get conversion rate (CR).
   description: Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getNoClickRate
+  x-acl:
+    - analytics
   summary: Get no click rate.
   description: Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
   parameters:

@@ -2,8 +2,10 @@ get:
   tags:
     - search
   operationId: getNoResultsRate
+  x-acl:
+    - analytics
   summary: Get no results rate.
-  description: Returns the rate at which searches didn't return any results. 
+  description: Returns the rate at which searches didn't return any results.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getSearchesCount
+  x-acl:
+    - analytics
   summary: Get number of searches.
   description: Returns the number of searches within a time range.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getSearchesNoClicks
+  x-acl:
+    - analytics
   summary: Get top searches with no clicks.
   description: Return the most popular of the last 1,000 searches that didn't lead to any clicks.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getSearchesNoResults
+  x-acl:
+    - analytics
   summary: Get top searches with no results.
   description: Returns the most popular of the latest 1,000 searches that didn't return any results.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getTopCountries
+  x-acl:
+    - analytics
   summary: Get top countries.
   description: Returns top countries. Limited to the 1,000 most frequent ones.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getTopFilterAttributes
+  x-acl:
+    - analytics
   summary: Get top filterable attributes.
   description: Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getTopFilterForAttribute
+  x-acl:
+    - analytics
   summary: Get top filter values for an attribute.
   description: Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getTopFiltersNoResults
+  x-acl:
+    - analytics
   summary: Get top filters for a no result search.
   description: Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getTopHits
+  x-acl:
+    - analytics
   summary: Get top hits.
   description: Return the most popular clicked results in the last 1,000 searches.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getTopSearches
+  x-acl:
+    - analytics
   summary: Get top searches.
   description: Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - search
   operationId: getUsersCount
+  x-acl:
+    - analytics
   summary: Get user count.
   description: Return the count of unique users.
   parameters:

@@ -2,6 +2,8 @@ get:
   tags:
     - advanced
   operationId: getStatus
+  x-acl:
+    - analytics
   summary: Get Analytics API status.
   description: >
     Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`.

@@ -4,6 +4,10 @@ get:
   summary: Get a authentication.
   description: Get the authentication of the given authenticationID.
   operationId: getAuthentication
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/pathAuthenticationID'
   responses:
@@ -22,6 +26,10 @@ patch:
   summary: Update a authentication.
   description: Update the authentication of the given authenticationID.
   operationId: updateAuthentication
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/pathAuthenticationID'
   requestBody:
@@ -46,6 +54,10 @@ delete:
   summary: Delete a authentication.
   description: Soft delete the authentication of the given authenticationID.
   operationId: deleteAuthentication
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/pathAuthenticationID'
   responses:

@@ -4,6 +4,10 @@ get:
   summary: Get a list of authentications.
   description: Get a list of authentications for the given query parameters, with pagination details.
   operationId: getAuthentications
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/itemsPerPage'
     - $ref: '../../common/parameters.yml#/page'
@@ -39,6 +43,10 @@ post:
   summary: Create a authentication.
   description: Create a authentication.
   operationId: createAuthentication
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   requestBody:
     description: ''
     content:

@@ -4,6 +4,10 @@ post:
   summary: Search among authentications.
   description: Search among authentications with a defined set of parameters.
   operationId: searchAuthentications
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   requestBody:
     content:
       application/json:

@@ -4,6 +4,10 @@ get:
   summary: Get a destination.
   description: Get the destination of the given destinationID.
   operationId: getDestination
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/pathDestinationID'
   responses:
@@ -22,6 +26,10 @@ patch:
   summary: Update a destination.
   description: Update the destination of the given destinationID.
   operationId: updateDestination
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/pathDestinationID'
   requestBody:
@@ -46,6 +54,10 @@ delete:
   summary: Delete a destination.
   description: Soft delete the destination of the given destinationID.
   operationId: deleteDestination
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/pathDestinationID'
   responses:

@@ -4,6 +4,10 @@ get:
   summary: Get a list of destinations.
   description: Get a list of destinations for the given query parameters, with pagination details.
   operationId: getDestinations
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/itemsPerPage'
     - $ref: '../../common/parameters.yml#/page'
@@ -39,6 +43,10 @@ post:
   summary: Create a destination.
   description: Create a destination.
   operationId: createDestination
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   requestBody:
     description: ''
     content:

@@ -4,6 +4,10 @@ post:
   summary: Search among destinations.
   description: Search among destinations with a defined set of parameters.
   operationId: searchDestinations
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   requestBody:
     content:
       application/json:

@@ -4,6 +4,10 @@ get:
   summary: Get an event.
   description: Get a single event for a specific runID.
   operationId: getEvent
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../../common/parameters.yml#/pathRunID'
     - $ref: '../../../common/parameters.yml#/pathEventID'

@@ -4,6 +4,10 @@ get:
   summary: Get a list of events.
   description: Get a list of events associated to the given runID, for the given query parameters.
   operationId: getEvents
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../../common/parameters.yml#/pathRunID'
     - $ref: '../../../common/parameters.yml#/itemsPerPage'

@@ -4,6 +4,10 @@ get:
   summary: Get a run.
   description: Get a single run for the given ID.
   operationId: getRun
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/pathRunID'
   responses:

@@ -4,6 +4,10 @@ get:
   summary: Get a list of runs.
   description: Get a list of runs for the given query parameters, with pagination details.
   operationId: getRuns
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
   parameters:
     - $ref: '../../common/parameters.yml#/itemsPerPage'
     - $ref: '../../common/parameters.yml#/page'