@algolia/client-analytics 5.9.1 → 5.10.0

package/model/orderBy.ts

@@ -1,6 +0,0 @@
-// 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.
-
-/**
- * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
- */
-export type OrderBy = 'searchCount' | 'clickThroughRate' | 'conversionRate' | 'averageClickPosition';

package/model/topCountry.ts

@@ -1,13 +0,0 @@
-// 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 = {
-  /**
-   * Country code.
-   */
-  country: string;
-
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-};

package/model/topHit.ts

@@ -1,13 +0,0 @@
-// 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 = {
-  /**
-   * Object ID of a record that\'s returned as a search result.
-   */
-  hit: string;
-
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-};

package/model/topHitWithAnalytics.ts

@@ -1,38 +0,0 @@
-// 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 = {
-  /**
-   * Object ID of a record that\'s returned as a search result.
-   */
-  hit: string;
-
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-
-  /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  clickThroughRate: number | null;
-
-  /**
-   * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  conversionRate: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedHitCount: number;
-
-  /**
-   * Number of clicks associated with this search.
-   */
-  clickCount: number;
-
-  /**
-   * Number of conversions from this search.
-   */
-  conversionCount: number;
-};

package/model/topHitWithRevenueAnalytics.ts

@@ -1,65 +0,0 @@
-// 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 { CurrencyCode } from './currencyCode';
-
-export type TopHitWithRevenueAnalytics = {
-  /**
-   * Object ID of a record that\'s returned as a search result.
-   */
-  hit: string;
-
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-
-  /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  clickThroughRate: number | null;
-
-  /**
-   * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  conversionRate: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedHitCount: number;
-
-  /**
-   * Number of clicks associated with this search.
-   */
-  clickCount: number;
-
-  /**
-   * Number of conversions from this search.
-   */
-  conversionCount: number;
-
-  /**
-   * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  addToCartRate: number | null;
-
-  /**
-   * Number of add-to-cart events from this search.
-   */
-  addToCartCount: number;
-
-  /**
-   * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  purchaseRate: number | null;
-
-  /**
-   * Number of purchase events from this search.
-   */
-  purchaseCount: number;
-
-  /**
-   * Revenue associated with this search, broken-down by currencies.
-   */
-  currencies: { [key: string]: CurrencyCode };
-};

package/model/topHitsResponse.ts

@@ -1,10 +0,0 @@
-// 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 = {
-  /**
-   * Most frequent search results.
-   */
-  hits: Array<TopHit>;
-};

package/model/topHitsResponseWithAnalytics.ts

@@ -1,10 +0,0 @@
-// 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 { TopHitWithAnalytics } from './topHitWithAnalytics';
-
-export type TopHitsResponseWithAnalytics = {
-  /**
-   * Most frequent search results with click and conversion metrics.
-   */
-  hits: Array<TopHitWithAnalytics>;
-};

package/model/topHitsResponseWithRevenueAnalytics.ts

@@ -1,10 +0,0 @@
-// 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 { TopHitWithRevenueAnalytics } from './topHitWithRevenueAnalytics';
-
-export type TopHitsResponseWithRevenueAnalytics = {
-  /**
-   * Most frequent search results with click, conversion, and revenue metrics.
-   */
-  hits: Array<TopHitWithRevenueAnalytics>;
-};

package/model/topSearch.ts

@@ -1,18 +0,0 @@
-// 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 TopSearch = {
-  /**
-   * Search query.
-   */
-  search: string;
-
-  /**
-   * Number of searches.
-   */
-  count: number;
-
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-};

package/model/topSearchWithAnalytics.ts

@@ -1,55 +0,0 @@
-// 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 TopSearchWithAnalytics = {
-  /**
-   * Search query.
-   */
-  search: string;
-
-  /**
-   * Number of searches.
-   */
-  count: number;
-
-  /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  clickThroughRate: number | null;
-
-  /**
-   * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  averageClickPosition: number | null;
-
-  /**
-   * List of positions in the search results and clicks associated with this search.
-   */
-  clickPositions: Array<ClickPosition>;
-
-  /**
-   * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  conversionRate: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedSearchCount: number;
-
-  /**
-   * Number of clicks associated with this search.
-   */
-  clickCount: number;
-
-  /**
-   * Number of conversions from this search.
-   */
-  conversionCount: number;
-
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-};

package/model/topSearchWithRevenueAnalytics.ts

@@ -1,81 +0,0 @@
-// 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';
-import type { CurrencyCode } from './currencyCode';
-
-export type TopSearchWithRevenueAnalytics = {
-  /**
-   * Search query.
-   */
-  search: string;
-
-  /**
-   * Number of searches.
-   */
-  count: number;
-
-  /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  clickThroughRate: number | null;
-
-  /**
-   * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  averageClickPosition: number | null;
-
-  /**
-   * List of positions in the search results and clicks associated with this search.
-   */
-  clickPositions: Array<ClickPosition>;
-
-  /**
-   * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  conversionRate: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedSearchCount: number;
-
-  /**
-   * Number of clicks associated with this search.
-   */
-  clickCount: number;
-
-  /**
-   * Number of conversions from this search.
-   */
-  conversionCount: number;
-
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-
-  /**
-   * Revenue associated with this search, broken-down by currencies.
-   */
-  currencies: { [key: string]: CurrencyCode };
-
-  /**
-   * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  addToCartRate: number | null;
-
-  /**
-   * Number of add-to-cart events from this search.
-   */
-  addToCartCount: number;
-
-  /**
-   * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  purchaseRate: number | null;
-
-  /**
-   * Number of purchase events from this search.
-   */
-  purchaseCount: number;
-};

package/model/topSearchesResponse.ts

@@ -1,10 +0,0 @@
-// 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 { TopSearch } from './topSearch';
-
-export type TopSearchesResponse = {
-  /**
-   * Most popular searches and their number of search results (hits).
-   */
-  searches: Array<TopSearch>;
-};

package/model/topSearchesResponseWithAnalytics.ts

@@ -1,10 +0,0 @@
-// 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 { TopSearchWithAnalytics } from './topSearchWithAnalytics';
-
-export type TopSearchesResponseWithAnalytics = {
-  /**
-   * Most popular searches and their associated click and conversion metrics.
-   */
-  searches: Array<TopSearchWithAnalytics>;
-};

package/model/topSearchesResponseWithRevenueAnalytics.ts

@@ -1,10 +0,0 @@
-// 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 { TopSearchWithRevenueAnalytics } from './topSearchWithRevenueAnalytics';
-
-export type TopSearchesResponseWithRevenueAnalytics = {
-  /**
-   * Most popular searches, including their click and revenue metrics.
-   */
-  searches: Array<TopSearchWithRevenueAnalytics>;
-};