@algolia/client-analytics 5.0.0-alpha.8 → 5.0.0-alpha.80

package/model/getClickPositionsResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { ClickPosition } from './clickPosition';
 
 export type GetClickPositionsResponse = {
   /**
-   * A list of the click positions with their click count.
+   * Click positions.
    */
   positions: ClickPosition[];
 };

package/model/getClickThroughRateResponse.ts

@@ -1,25 +1,25 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getConversationRateResponse.ts

@@ -1,25 +1,25 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getNoClickRateResponse.ts

@@ -1,25 +1,25 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getNoResultsRateResponse.ts

@@ -1,25 +1,25 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getSearchesCountResponse.ts

@@ -1,15 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getSearchesNoClicksResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getSearchesNoResultsResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getStatusResponse.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getTopCountriesResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { TopCountry } from './topCountry';
 
 export type GetTopCountriesResponse = {
   /**
-   * A list of countries with their count.
+   * Countries.
    */
   countries: TopCountry[];
 };

package/model/getTopFilterAttribute.ts

@@ -1,13 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type GetTopFilterAttribute = {
   /**
-   * The attribute.
+   * Attribute name.
    */
   attribute: string;
 
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 };

package/model/getTopFilterAttributesResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { GetTopFilterAttribute } from './getTopFilterAttribute';
 
 export type GetTopFilterAttributesResponse = {
   /**
-   * A list of attributes with their count.
+   * Filterable attributes.
    */
   attributes: GetTopFilterAttribute[];
 };

package/model/getTopFilterForAttribute.ts

@@ -1,23 +1,23 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getTopFilterForAttributeResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { GetTopFilterForAttribute } from './getTopFilterForAttribute';
 
 export type GetTopFilterForAttributeResponse = {
   /**
-   * A list of filters for the given attributes.
+   * Filter values for an attribute.
    */
   values: GetTopFilterForAttribute[];
 };

package/model/getTopFiltersNoResultsResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValues';
 
 export type GetTopFiltersNoResultsResponse = {
   /**
-   * A list of filters without results.
+   * Filters with no results.
    */
   values: GetTopFiltersNoResultsValues[];
 };

package/model/getTopFiltersNoResultsValue.ts

@@ -1,18 +1,18 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type GetTopFiltersNoResultsValue = {
   /**
-   * The attribute.
+   * Attribute name.
    */
   attribute: string;
 
   /**
-   * The operator.
+   * Operator.
    */
   operator: string;
 
   /**
-   * The value of the attribute.
+   * Attribute value.
    */
   value: string;
 };

package/model/getTopFiltersNoResultsValues.ts

@@ -1,15 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/getTopHitsResponse.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { TopHitsResponse } from './topHitsResponse';
 import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';

package/model/getTopSearchesResponse.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { TopSearchesResponse } from './topSearchesResponse';
 import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';

package/model/getUsersCountResponse.ts

@@ -1,15 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/index.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export * from './averageClickEvent';
 export * from './clickPosition';

package/model/noClickRateEvent.ts

@@ -1,23 +1,23 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/noResultsRateEvent.ts

@@ -1,23 +1,23 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/orderBy.ts

@@ -1,5 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+/**
+ * Method for ordering results. `clickThroughRate`, `conversionRate` and `averageClickPosition` are only available if the `clickAnalytics` parameter is `true`.
+ */
 export type OrderBy =
   | 'averageClickPosition'
   | 'clickThroughRate'

package/model/searchEvent.ts

@@ -1,13 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/searchNoClickEvent.ts

@@ -1,18 +1,18 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/searchNoResultEvent.ts

@@ -1,18 +1,18 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/topCountry.ts

@@ -1,13 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type TopCountry = {
   /**
-   * The country.
+   * Country.
    */
   country: string;
 
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 };

package/model/topHit.ts

@@ -1,13 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type TopHit = {
   /**
-   * The hit.
+   * Hit.
    */
   hit: string;
 
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 };

package/model/topHitWithAnalytics.ts

@@ -1,38 +1,38 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 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/model/topHitsResponse.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { TopHit } from './topHit';
 
 export type TopHitsResponse = {
   /**
-   * A list of top hits with their count.
+   * Top hits.
    */
   hits: TopHit[];
 };