Sep 20, 2024
Analytics API client
This client is new in v3 of the Kotlin API clients.
The Analytics API client is part of the algoliasearch-scala
package.
You can add this package to your build.gradle.kts
file:
Copy
1
2
3
implementation("com.algolia:algoliasearch-client-kotlin:3.8.0")
// You also need to add a KTOR engine as dependency, for example:
implementation("io.ktor:ktor-client-java:$ktor_version")
To use the Analytics client, add this import to your files:
Copy
1
import com.algolia.client.api.AnalyticsClient
To create an instance of the client:
Copy
1
val client = AnalyticsClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY", region = "ALGOLIA_APPLICATION_REGION")
Replace ALGOLIA_APPLICATION_ID_REGION
with your Algolia application’s analytics region: us
for the United States or de
for Europe.
You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.
List of methods
Each method makes one request to the Analytics API.
Searches
client.getTopSearches | Retrieve top searches |
client.getSearchesCount | Retrieve number of searches |
client.getSearchesNoResults | Retrieve top searches without results |
client.getNoResultsRate | Retrieve no results rate |
client.getTopHits | Retrieve top search results |
Clicks
client.getSearchesNoClicks | Retrieve top searches without clicks |
client.getNoClickRate | Retrieve no click rate |
client.getAverageClickPosition | Retrieve average click position |
client.getClickPositions | Retrieve click positions |
client.getClickThroughRate | Retrieve click-through rate |
client.getConversionRate | Retrieve conversion rate |
client.getAddToCartRate | Retrieve add-to-cart rate |
client.getPurchaseRate | Retrieve purchase rate |
client.getRevenue | Retrieve revenue data |
Users
client.getUsersCount | Retrieve number of users |
client.getTopCountries | Retrieve top countries |
Filters
client.getTopFilterAttributes | Retrieve top filters |
client.getTopFilterForAttribute | Retrieve top filter values |
client.getTopFiltersNoResults | Retrieve top filters for a search without results |
Status
client.getStatus | Retrieve update status |
Did you find this page helpful?