Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- body
-
Parameters to send with the custom request.
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
This method allow you to send requests to the Algolia REST API.
This method allow you to send requests to the Algolia REST API.
Value parameters
- body
-
Parameters to send with the custom request.
- parameters
-
Query parameters to apply to the current query.
- path
-
Path of the endpoint, anything after "/1" must be specified.
Attributes
Return the average click position for the complete time range and for individual days. > Note: If all positions
have a clickCount
of 0
or null
, it means Algolia didn't receive any click events for tracked searches. A tracked search is a search request where the clickAnalytics
parameter is true
.
Return the average click position for the complete time range and for individual days. > Note: If all positions
have a clickCount
of 0
or null
, it means Algolia didn't receive any click events for tracked searches. A tracked search is a search request where the clickAnalytics
parameter is true
.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Show the number of clicks events and their associated position in the search results. > Note: If all positions
have a clickCount
of 0
or null
, it means Algolia didn't receive any click events for tracked searches. A tracked search is a search request where the clickAnalytics
parameter is true
.
Show the number of clicks events and their associated position in the search results. > Note: If all positions
have a clickCount
of 0
or null
, it means Algolia didn't receive any click events for tracked searches. A tracked search is a search request where the clickAnalytics
parameter is true
.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Returns a click-through rate (CTR).
Returns a click-through rate (CTR).
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Return a conversion rate.
Return a conversion rate.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
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.
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.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Returns the rate at which searches didn't return any results.
Returns the rate at which searches didn't return any results.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Returns the number of searches within a time range.
Returns the number of searches within a time range.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Return the most popular of the last 1,000 searches that didn't lead to any clicks.
Return the most popular of the last 1,000 searches that didn't lead to any clicks.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- limit
-
Number of records to return (page size).
- offset
-
Position of the starting record. Used for paging. 0 is the first record.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Returns the most popular of the latest 1,000 searches that didn't return any results.
Returns the most popular of the latest 1,000 searches that didn't return any results.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- limit
-
Number of records to return (page size).
- offset
-
Position of the starting record. Used for paging. 0 is the first record.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
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
. > Note: The Analytics API is updated every 5 minutes.
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
. > Note: The Analytics API is updated every 5 minutes.
Value parameters
- index
-
Index name to target.
Attributes
Returns top countries. Limited to the 1,000 most frequent ones.
Returns top countries. Limited to the 1,000 most frequent ones.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- limit
-
Number of records to return (page size).
- offset
-
Position of the starting record. Used for paging. 0 is the first record.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Return the most popular filterable attributes in the 1,000 most recently used filters.
Return the most popular filterable attributes in the 1,000 most recently used filters.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- limit
-
Number of records to return (page size).
- offset
-
Position of the starting record. Used for paging. 0 is the first record.
- search
-
User query.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
Value parameters
- attribute
-
Attribute name.
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- limit
-
Number of records to return (page size).
- offset
-
Position of the starting record. Used for paging. 0 is the first record.
- search
-
User query.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- limit
-
Number of records to return (page size).
- offset
-
Position of the starting record. Used for paging. 0 is the first record.
- search
-
User query.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Return the most popular clicked results in the last 1,000 searches.
Return the most popular clicked results in the last 1,000 searches.
Value parameters
- clickAnalytics
-
Whether to include click and conversion rates for a search.
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- limit
-
Number of records to return (page size).
- offset
-
Position of the starting record. Used for paging. 0 is the first record.
- search
-
User query.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
Value parameters
- clickAnalytics
-
Whether to include click and conversion rates for a search.
- direction
-
Sorting direction of the results: ascending or descending.
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- limit
-
Number of records to return (page size).
- offset
-
Position of the starting record. Used for paging. 0 is the first record.
- orderBy
-
Reorder the results.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.
Attributes
Return the count of unique users.
Return the count of unique users.
Value parameters
- endDate
-
End date (a string in the format
YYYY-MM-DD
) of the period to analyze. - index
-
Index name to target.
- startDate
-
Start date (a string in the format
YYYY-MM-DD
) of the period to analyze. - tags
-
Filter analytics on the
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.