@algolia/client-analytics 5.0.0-alpha.73 → 5.0.0-alpha.75

package/dist/model/getAverageClickPositionResponse.d.ts

@@ -1,15 +1,15 @@
 import type { AverageClickEvent } from './averageClickEvent';
 export type GetAverageClickPositionResponse = {
     /**
-     * The average of all the click count event.
+     * Average count of all click events.
      */
     average: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     clickCount: number;
     /**
-     * A list of average click position with their date.
+     * Average click positions.
      */
     dates: AverageClickEvent[];
 };

package/dist/model/getClickPositionsResponse.d.ts

@@ -1,7 +1,7 @@
 import type { ClickPosition } from './clickPosition';
 export type GetClickPositionsResponse = {
     /**
-     * A list of the click positions with their click count.
+     * Click positions.
      */
     positions: ClickPosition[];
 };

package/dist/model/getClickThroughRateResponse.d.ts

@@ -1,19 +1,19 @@
 import type { ClickThroughRateEvent } from './clickThroughRateEvent';
 export type GetClickThroughRateResponse = {
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     rate: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     clickCount: number;
     /**
-     * The number of tracked search click.
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
      */
     trackedSearchCount: number;
     /**
-     * A list of click-through rate events with their date.
+     * Click-through rate events.
      */
     dates: ClickThroughRateEvent[];
 };

package/dist/model/getConversationRateResponse.d.ts

@@ -1,19 +1,19 @@
 import type { ConversionRateEvent } from './conversionRateEvent';
 export type GetConversationRateResponse = {
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     rate: number;
     /**
-     * The number of tracked search click.
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
      */
     trackedSearchCount: number;
     /**
-     * The number of converted clicks.
+     * Number of converted clicks.
      */
     conversionCount: number;
     /**
-     * A list of conversion events with their date.
+     * Conversion events.
      */
     dates: ConversionRateEvent[];
 };

package/dist/model/getNoClickRateResponse.d.ts

@@ -1,19 +1,19 @@
 import type { NoClickRateEvent } from './noClickRateEvent';
 export type GetNoClickRateResponse = {
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     rate: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     count: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     noClickCount: number;
     /**
-     * A list of searches without clicks with their date, rate and counts.
+     * Overall count of searches without clicks plus a daily breakdown.
      */
     dates: NoClickRateEvent[];
 };

package/dist/model/getNoResultsRateResponse.d.ts

@@ -1,19 +1,19 @@
 import type { NoResultsRateEvent } from './noResultsRateEvent';
 export type GetNoResultsRateResponse = {
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     rate: number;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     noResultCount: number;
     /**
-     * A list of searches without results with their date, rate and counts.
+     * Overall count of searches without results plus a daily breakdown.
      */
     dates: NoResultsRateEvent[];
 };

package/dist/model/getSearchesCountResponse.d.ts

@@ -1,11 +1,11 @@
 import type { SearchEvent } from './searchEvent';
 export type GetSearchesCountResponse = {
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
     /**
-     * A list of search events with their date and count.
+     * Search events with their associated dates and hit counts.
      */
     dates: SearchEvent[];
 };

package/dist/model/getSearchesNoClicksResponse.d.ts

@@ -1,7 +1,7 @@
 import type { SearchNoClickEvent } from './searchNoClickEvent';
 export type GetSearchesNoClicksResponse = {
     /**
-     * A list of searches with no clicks and their count.
+     * Searches with no clicks.
      */
     searches: SearchNoClickEvent[];
 };

package/dist/model/getSearchesNoResultsResponse.d.ts

@@ -1,7 +1,7 @@
 import type { SearchNoResultEvent } from './searchNoResultEvent';
 export type GetSearchesNoResultsResponse = {
     /**
-     * A list of searches with no results and their count.
+     * Searches with no results.
      */
     searches: SearchNoResultEvent[];
 };

package/dist/model/getStatusResponse.d.ts

@@ -1,6 +1,6 @@
 export type GetStatusResponse = {
     /**
-     * Date of last update (ISO-8601 format).
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     updatedAt: string;
 };

package/dist/model/getTopCountriesResponse.d.ts

@@ -1,7 +1,7 @@
 import type { TopCountry } from './topCountry';
 export type GetTopCountriesResponse = {
     /**
-     * A list of countries with their count.
+     * Countries.
      */
     countries: TopCountry[];
 };

package/dist/model/getTopFilterAttribute.d.ts

@@ -1,10 +1,10 @@
 export type GetTopFilterAttribute = {
     /**
-     * The attribute.
+     * Attribute name.
      */
     attribute: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
 };

package/dist/model/getTopFilterAttributesResponse.d.ts

@@ -1,7 +1,7 @@
 import type { GetTopFilterAttribute } from './getTopFilterAttribute';
 export type GetTopFilterAttributesResponse = {
     /**
-     * A list of attributes with their count.
+     * Filterable attributes.
      */
     attributes: GetTopFilterAttribute[];
 };

package/dist/model/getTopFilterForAttribute.d.ts

@@ -1,18 +1,18 @@
 export type GetTopFilterForAttribute = {
     /**
-     * The attribute.
+     * Attribute name.
      */
     attribute: string;
     /**
-     * The operator.
+     * Operator.
      */
     operator: string;
     /**
-     * The value of the attribute.
+     * Attribute value.
      */
     value: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
 };

package/dist/model/getTopFilterForAttributeResponse.d.ts

@@ -1,7 +1,7 @@
 import type { GetTopFilterForAttribute } from './getTopFilterForAttribute';
 export type GetTopFilterForAttributeResponse = {
     /**
-     * A list of filters for the given attributes.
+     * Filter values for an attribute.
      */
     values: GetTopFilterForAttribute[];
 };

package/dist/model/getTopFiltersNoResultsResponse.d.ts

@@ -1,7 +1,7 @@
 import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValues';
 export type GetTopFiltersNoResultsResponse = {
     /**
-     * A list of filters without results.
+     * Filters with no results.
      */
     values: GetTopFiltersNoResultsValues[];
 };

package/dist/model/getTopFiltersNoResultsValue.d.ts

@@ -1,14 +1,14 @@
 export type GetTopFiltersNoResultsValue = {
     /**
-     * The attribute.
+     * Attribute name.
      */
     attribute: string;
     /**
-     * The operator.
+     * Operator.
      */
     operator: string;
     /**
-     * The value of the attribute.
+     * Attribute value.
      */
     value: string;
 };

package/dist/model/getTopFiltersNoResultsValues.d.ts

@@ -1,11 +1,11 @@
 import type { GetTopFiltersNoResultsValue } from './getTopFiltersNoResultsValue';
 export type GetTopFiltersNoResultsValues = {
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
     /**
-     * A list of filters without results.
+     * Filters with no results.
      */
     values: GetTopFiltersNoResultsValue[];
 };

package/dist/model/getUsersCountResponse.d.ts

@@ -1,11 +1,11 @@
 import type { UserWithDate } from './userWithDate';
 export type GetUsersCountResponse = {
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
     /**
-     * A list of users count with their date.
+     * User count.
      */
     dates: UserWithDate[];
 };

package/dist/model/noClickRateEvent.d.ts

@@ -1,18 +1,18 @@
 export type NoClickRateEvent = {
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     rate: number;
     /**
-     * The number of click event.
+     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
      */
     count: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     noClickCount: number;
     /**
-     * Date of the event.
+     * Date of the event in the format YYYY-MM-DD.
      */
     date: string;
 };

package/dist/model/noResultsRateEvent.d.ts

@@ -1,18 +1,18 @@
 export type NoResultsRateEvent = {
     /**
-     * Date of the event.
+     * Date of the event in the format YYYY-MM-DD.
      */
     date: string;
     /**
-     * The number of occurrences.
+     * Number of occurences.
      */
     noResultCount: number;
     /**
-     * The number of occurrences.
+     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
      */
     count: number;
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     rate: number;
 };

package/dist/model/orderBy.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Method for ordering results. `clickThroughRate`, `conversionRate` and `averageClickPosition` are only available if the `clickAnalytics` parameter is `true`.
+ */
 export type OrderBy = 'averageClickPosition' | 'clickThroughRate' | 'conversionRate' | 'searchCount';
 //# sourceMappingURL=orderBy.d.ts.map

package/dist/model/orderBy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orderBy.d.ts","sourceRoot":"","sources":["../../model/orderBy.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,GACf,sBAAsB,GACtB,kBAAkB,GAClB,gBAAgB,GAChB,aAAa,CAAC"}
+{"version":3,"file":"orderBy.d.ts","sourceRoot":"","sources":["../../model/orderBy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,OAAO,GACf,sBAAsB,GACtB,kBAAkB,GAClB,gBAAgB,GAChB,aAAa,CAAC"}

package/dist/model/searchEvent.d.ts

@@ -1,10 +1,10 @@
 export type SearchEvent = {
     /**
-     * Date of the event.
+     * Date of the event in the format YYYY-MM-DD.
      */
     date: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
 };

package/dist/model/searchNoClickEvent.d.ts

@@ -1,14 +1,14 @@
 export type SearchNoClickEvent = {
     /**
-     * The search query.
+     * User query.
      */
     search: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     withFilterCount: number;
 };

package/dist/model/searchNoResultEvent.d.ts

@@ -1,14 +1,14 @@
 export type SearchNoResultEvent = {
     /**
-     * The search query.
+     * User query.
      */
     search: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
     /**
-     * Number of hits that the search query matched.
+     * Number of hits the search query matched.
      */
     nbHits: number;
 };

package/dist/model/topCountry.d.ts

@@ -1,10 +1,10 @@
 export type TopCountry = {
     /**
-     * The country.
+     * Country.
      */
     country: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
 };

package/dist/model/topHit.d.ts

@@ -1,10 +1,10 @@
 export type TopHit = {
     /**
-     * The hit.
+     * Hit.
      */
     hit: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
 };

package/dist/model/topHitWithAnalytics.d.ts

@@ -1,30 +1,30 @@
 export type TopHitWithAnalytics = {
     /**
-     * The hit.
+     * Hit.
      */
     hit: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     clickThroughRate: number;
     /**
-     * The conversion rate.
+     * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      */
     conversionRate: number;
     /**
-     * The number of tracked search click.
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
      */
     trackedSearchCount: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     clickCount: number;
     /**
-     * The number of converted clicks.
+     * Number of converted clicks.
      */
     conversionCount: number;
 };

package/dist/model/topHitsResponse.d.ts

@@ -1,7 +1,7 @@
 import type { TopHit } from './topHit';
 export type TopHitsResponse = {
     /**
-     * A list of top hits with their count.
+     * Top hits.
      */
     hits: TopHit[];
 };

package/dist/model/topHitsResponseWithAnalytics.d.ts

@@ -1,7 +1,7 @@
 import type { TopHitWithAnalytics } from './topHitWithAnalytics';
 export type TopHitsResponseWithAnalytics = {
     /**
-     * A list of top hits with their count and analytics.
+     * Top hits.
      */
     hits: TopHitWithAnalytics[];
 };

package/dist/model/topSearch.d.ts

@@ -1,14 +1,14 @@
 export type TopSearch = {
     /**
-     * The search query.
+     * User query.
      */
     search: string;
     /**
-     * The number of occurrences.
+     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
      */
     count: number;
     /**
-     * Number of hits that the search query matched.
+     * Number of hits the search query matched.
      */
     nbHits: number;
 };

package/dist/model/topSearchWithAnalytics.d.ts

@@ -1,38 +1,38 @@
 export type TopSearchWithAnalytics = {
     /**
-     * The search query.
+     * User query.
      */
     search: string;
     /**
-     * The number of occurrences.
+     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
      */
     count: number;
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     clickThroughRate: number;
     /**
-     * The average position of all the click count event.
+     * Average [position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) of clicked search result.
      */
     averageClickPosition: number;
     /**
-     * The conversion rate.
+     * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      */
     conversionRate: number;
     /**
-     * The number of tracked search click.
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
      */
     trackedSearchCount: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     clickCount: number;
     /**
-     * The number of converted clicks.
+     * Number of converted clicks.
      */
     conversionCount: number;
     /**
-     * Number of hits that the search query matched.
+     * Number of hits the search query matched.
      */
     nbHits: number;
 };

package/dist/model/topSearchesResponse.d.ts

@@ -1,7 +1,7 @@
 import type { TopSearch } from './topSearch';
 export type TopSearchesResponse = {
     /**
-     * A list of top searches with their count.
+     * Top searches with their hits count.
      */
     searches: TopSearch[];
 };

package/dist/model/topSearchesResponseWithAnalytics.d.ts

@@ -1,7 +1,7 @@
 import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
 export type TopSearchesResponseWithAnalytics = {
     /**
-     * A list of top searches with their count and analytics.
+     * Top searches with their hits count and analytics.
      */
     searches: TopSearchWithAnalytics[];
 };

package/dist/model/userWithDate.d.ts

@@ -1,10 +1,10 @@
 export type UserWithDate = {
     /**
-     * Date of the event.
+     * Date of the event in the format YYYY-MM-DD.
      */
     date: string;
     /**
-     * The number of occurrences.
+     * Number of occurrences.
      */
     count: number;
 };