Sep 20, 2024
Analytics API client
This client is new in v7 of the C# API clients.
The Analytics API client is part of the algoliasearch-client-swift
package.
To install this package, add the :
Copy
1
dotnet add package Algolia.Search
To use the Analytics client, import these namespaces:
Copy
1
2
3
using Algolia.Search.Clients;
using Algolia.Search.Http;
using Algolia.Search.Models.Analytics;
To create an instance of the client:
Copy
1
2
3
var client = new AnalyticsClient(
new AnalyticsConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "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 the most frequent 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 |
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 |
Revenue
client.GetRevenue | Retrieve revenue data |
Status
client.GetStatus | Retrieve update status |
Did you find this page helpful?