@algolia/client-analytics 5.0.0-alpha.11 → 5.0.0-alpha.110

package/model/currenciesValue.ts

@@ -0,0 +1,16 @@
+// 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.
+
+/**
+ * Currency code.
+ */
+export type CurrenciesValue = {
+  /**
+   * Currency code.
+   */
+  currency?: string;
+
+  /**
+   * Revenue associated with this search in this currency.
+   */
+  revenue?: number;
+};

package/model/dailyAddToCartRates.ts

@@ -0,0 +1,23 @@
+// 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 DailyAddToCartRates = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of add-to-cart events from this search.
+   */
+  addToCartCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyAverageClicks.ts

@@ -0,0 +1,18 @@
+// 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 DailyAverageClicks = {
+  /**
+   * 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.
+   */
+  average: number | null;
+
+  /**
+   * Number of clicks associated with this search.
+   */
+  clickCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyClickThroughRates.ts

@@ -0,0 +1,23 @@
+// 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 DailyClickThroughRates = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of clicks associated with this search.
+   */
+  clickCount: number;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyConversionRates.ts

@@ -0,0 +1,23 @@
+// 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 DailyConversionRates = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of conversions from this search.
+   */
+  conversionCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyNoClickRates.ts

@@ -0,0 +1,23 @@
+// 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 DailyNoClickRates = {
+  /**
+   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+   */
+  rate: number;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  count: number;
+
+  /**
+   * Number of times this search was returned as a result without any click.
+   */
+  noClickCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyNoResultsRates.ts

@@ -0,0 +1,23 @@
+// 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 DailyNoResultsRates = {
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+
+  /**
+   * Number of searches without any results.
+   */
+  noResultCount: number;
+
+  /**
+   * Number of searches.
+   */
+  count: number;
+
+  /**
+   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+   */
+  rate: number;
+};

package/model/dailyPurchaseRates.ts

@@ -0,0 +1,23 @@
+// 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 DailyPurchaseRates = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of purchase events from this search.
+   */
+  purchaseCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyRevenue.ts

@@ -0,0 +1,15 @@
+// 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 { CurrenciesValue } from './currenciesValue';
+
+export type DailyRevenue = {
+  /**
+   * Revenue associated with this search, broken-down by currencies.
+   */
+  currencies: Record<string, CurrenciesValue>;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailySearches.ts

@@ -0,0 +1,13 @@
+// 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 DailySearches = {
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+
+  /**
+   * Number of occurrences.
+   */
+  count: number;
+};

package/model/dailySearchesNoClicks.ts

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

package/model/dailySearchesNoResults.ts

@@ -0,0 +1,18 @@
+// 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 DailySearchesNoResults = {
+  /**
+   * Search query.
+   */
+  search: string;
+
+  /**
+   * Number of occurrences.
+   */
+  count: number;
+
+  /**
+   * Number of searches for this term with applied filters.
+   */
+  withFilterCount: number;
+};

package/model/dailyUsers.ts

@@ -0,0 +1,13 @@
+// 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 DailyUsers = {
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+
+  /**
+   * Number of unique users.
+   */
+  count: number;
+};

package/model/direction.ts

@@ -1,3 +1,3 @@
-// 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 Direction = 'asc' | 'desc';

package/model/errorBase.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.
 
 /**
  * Error.

package/model/getAddToCartRateResponse.ts

@@ -0,0 +1,25 @@
+// 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 { DailyAddToCartRates } from './dailyAddToCartRates';
+
+export type GetAddToCartRateResponse = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of add-to-cart events from this search.
+   */
+  addToCartCount: number;
+
+  /**
+   * Daily add-to-cart rates.
+   */
+  dates: DailyAddToCartRates[];
+};

package/model/getAverageClickPositionResponse.ts

@@ -1,20 +1,20 @@
-// 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 { AverageClickEvent } from './averageClickEvent';
+import type { DailyAverageClicks } from './dailyAverageClicks';
 
 export type GetAverageClickPositionResponse = {
   /**
-   * The average of all the click count event.
+   * 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.
    */
-  average: number;
+  average: number | null;
 
   /**
-   * The number of click event.
+   * Number of clicks associated with this search.
    */
   clickCount: number;
 
   /**
-   * A list of average click position with their date.
+   * Daily average click positions.
    */
-  dates: AverageClickEvent[];
+  dates: DailyAverageClicks[];
 };

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';
+import type { ClickPositionsInner } from './clickPositionsInner';
 
 export type GetClickPositionsResponse = {
   /**
-   * A list of the click positions with their click count.
+   * List of positions in the search results and clicks associated with this search.
    */
-  positions: ClickPosition[];
+  positions: ClickPositionsInner[];
 };

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';
+import type { DailyClickThroughRates } from './dailyClickThroughRates';
 
 export type GetClickThroughRateResponse = {
   /**
-   * The click-through rate.
+   * 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.
    */
-  rate: number;
+  rate: number | null;
 
   /**
-   * The number of click event.
+   * Number of clicks associated with this search.
    */
   clickCount: number;
 
   /**
-   * The number of tracked search click.
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
    */
   trackedSearchCount: number;
 
   /**
-   * A list of click-through rate events with their date.
+   * Daily click-through rates.
    */
-  dates: ClickThroughRateEvent[];
+  dates: DailyClickThroughRates[];
 };

package/model/getConversionRateResponse.ts

@@ -0,0 +1,25 @@
+// 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 { DailyConversionRates } from './dailyConversionRates';
+
+export type GetConversionRateResponse = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of conversions from this search.
+   */
+  conversionCount: number;
+
+  /**
+   * Daily conversion rates.
+   */
+  dates: DailyConversionRates[];
+};

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';
+import type { DailyNoClickRates } from './dailyNoClickRates';
 
 export type GetNoClickRateResponse = {
   /**
-   * The click-through rate.
+   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
    */
   rate: number;
 
   /**
-   * The number of click event.
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
    */
   count: number;
 
   /**
-   * The number of click event.
+   * Number of times this search was returned as a result without any click.
    */
   noClickCount: number;
 
   /**
-   * A list of searches without clicks with their date, rate and counts.
+   * Daily no click rates.
    */
-  dates: NoClickRateEvent[];
+  dates: DailyNoClickRates[];
 };

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';
+import type { DailyNoResultsRates } from './dailyNoResultsRates';
 
 export type GetNoResultsRateResponse = {
   /**
-   * The click-through rate.
+   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
    */
   rate: number;
 
   /**
-   * The number of occurrences.
+   * Number of searches.
    */
   count: number;
 
   /**
-   * The number of occurrences.
+   * Number of searches without any results.
    */
   noResultCount: number;
 
   /**
-   * A list of searches without results with their date, rate and counts.
+   * Daily no results rates.
    */
-  dates: NoResultsRateEvent[];
+  dates: DailyNoResultsRates[];
 };

package/model/getPurchaseRateResponse.ts

@@ -0,0 +1,25 @@
+// 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 { DailyPurchaseRates } from './dailyPurchaseRates';
+
+export type GetPurchaseRateResponse = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of purchase events from this search.
+   */
+  purchaseCount: number;
+
+  /**
+   * Daily purchase rates.
+   */
+  dates: DailyPurchaseRates[];
+};

package/model/getRevenue.ts

@@ -0,0 +1,16 @@
+// 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 { CurrenciesValue } from './currenciesValue';
+import type { DailyRevenue } from './dailyRevenue';
+
+export type GetRevenue = {
+  /**
+   * Revenue associated with this search, broken-down by currencies.
+   */
+  currencies: Record<string, CurrenciesValue>;
+
+  /**
+   * Daily revenue.
+   */
+  dates: DailyRevenue[];
+};

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';
+import type { DailySearches } from './dailySearches';
 
 export type GetSearchesCountResponse = {
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 
   /**
-   * A list of search events with their date and count.
+   * Daily number of searches.
    */
-  dates: SearchEvent[];
+  dates: DailySearches[];
 };

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';
+import type { DailySearchesNoClicks } from './dailySearchesNoClicks';
 
 export type GetSearchesNoClicksResponse = {
   /**
-   * A list of searches with no clicks and their count.
+   * Searches without any clicks.
    */
-  searches: SearchNoClickEvent[];
+  searches: DailySearchesNoClicks[];
 };

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';
+import type { DailySearchesNoResults } from './dailySearchesNoResults';
 
 export type GetSearchesNoResultsResponse = {
   /**
-   * A list of searches with no results and their count.
+   * Searches without results.
    */
-  searches: SearchNoResultEvent[];
+  searches: DailySearchesNoResults[];
 };

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. If null, no update was performed yet.
    */
-  updatedAt: string;
+  updatedAt: string | null;
 };

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 and number of searches.
    */
   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.
+   * Most frequent filters.
    */
   attributes: GetTopFilterAttribute[];
 };