@algolia/client-analytics 5.0.0-alpha.99 → 5.0.0-beta.2

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/{searchEvent.ts → dailySearches.ts}

@@ -1,8 +1,8 @@
 // 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 = {
+export type DailySearches = {
   /**
-   * Date of the event in the format YYYY-MM-DD.
+   * Date in the format YYYY-MM-DD.
    */
   date: string;
 

package/model/{searchNoResultEvent.ts → dailySearchesNoClicks.ts}

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

package/model/{searchNoClickEvent.ts → dailySearchesNoResults.ts}

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

package/model/{userWithDate.ts → dailyUsers.ts}

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

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 @@
 // 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 = {
   /**
-   * Average count of all click events.
+   * 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;
 
   /**
-   * Number of click events.
+   * Number of clicks associated with this search.
    */
   clickCount: number;
 
   /**
-   * Average click positions.
+   * Daily average click positions.
    */
-  dates: AverageClickEvent[];
+  dates: DailyAverageClicks[];
 };

package/model/getClickPositionsResponse.ts

@@ -1,10 +1,10 @@
 // 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 = {
   /**
-   * Click positions.
+   * 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 @@
 // 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 = {
   /**
-   * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#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;
 
   /**
-   * Number of click events.
+   * Number of clicks associated with this search.
    */
   clickCount: number;
 
   /**
-   * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
    */
   trackedSearchCount: number;
 
   /**
-   * Click-through rate events.
+   * 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 @@
 // 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 = {
   /**
-   * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
    */
   rate: number;
 
   /**
-   * Number of click events.
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
    */
   count: number;
 
   /**
-   * Number of click events.
+   * Number of times this search was returned as a result without any click.
    */
   noClickCount: number;
 
   /**
-   * Overall count of searches without clicks plus a daily breakdown.
+   * Daily no click rates.
    */
-  dates: NoClickRateEvent[];
+  dates: DailyNoClickRates[];
 };

package/model/getNoResultsRateResponse.ts

@@ -1,25 +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 { NoResultsRateEvent } from './noResultsRateEvent';
+import type { DailyNoResultsRates } from './dailyNoResultsRates';
 
 export type GetNoResultsRateResponse = {
   /**
-   * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
    */
   rate: number;
 
   /**
-   * Number of occurrences.
+   * Number of searches.
    */
   count: number;
 
   /**
-   * Number of occurrences.
+   * Number of searches without any results.
    */
   noResultCount: number;
 
   /**
-   * Overall count of searches without results plus a daily breakdown.
+   * 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,6 +1,6 @@
 // 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 = {
   /**
@@ -9,7 +9,7 @@ export type GetSearchesCountResponse = {
   count: number;
 
   /**
-   * Search events with their associated dates and hit counts.
+   * Daily number of searches.
    */
-  dates: SearchEvent[];
+  dates: DailySearches[];
 };

package/model/getSearchesNoClicksResponse.ts

@@ -1,10 +1,10 @@
 // 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 = {
   /**
-   * Searches with no clicks.
+   * Searches without any clicks.
    */
-  searches: SearchNoClickEvent[];
+  searches: DailySearchesNoClicks[];
 };

package/model/getSearchesNoResultsResponse.ts

@@ -1,10 +1,10 @@
 // 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 = {
   /**
-   * Searches with no results.
+   * Searches without results.
    */
-  searches: SearchNoResultEvent[];
+  searches: DailySearchesNoResults[];
 };

package/model/getStatusResponse.ts

@@ -2,7 +2,7 @@
 
 export type GetStatusResponse = {
   /**
-   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was updated, in RFC 3339 format.
    */
-  updatedAt: string;
+  updatedAt: string | null;
 };

package/model/getTopCountriesResponse.ts

@@ -4,7 +4,7 @@ import type { TopCountry } from './topCountry';
 
 export type GetTopCountriesResponse = {
   /**
-   * Countries.
+   * Countries and number of searches.
    */
   countries: TopCountry[];
 };

package/model/getTopFilterAttributesResponse.ts

@@ -4,7 +4,7 @@ import type { GetTopFilterAttribute } from './getTopFilterAttribute';
 
 export type GetTopFilterAttributesResponse = {
   /**
-   * Filterable attributes.
+   * Most frequent filters.
    */
   attributes: GetTopFilterAttribute[];
 };

package/model/getTopFilterForAttribute.ts

@@ -1,15 +1,14 @@
 // 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 { Operator } from './operator';
+
 export type GetTopFilterForAttribute = {
   /**
    * Attribute name.
    */
   attribute: string;
 
-  /**
-   * Operator.
-   */
-  operator: string;
+  operator: Operator;
 
   /**
    * Attribute value.

package/model/getTopFiltersNoResultsResponse.ts

@@ -4,7 +4,7 @@ import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValue
 
 export type GetTopFiltersNoResultsResponse = {
   /**
-   * Filters with no results.
+   * Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request.
    */
-  values: GetTopFiltersNoResultsValues[];
+  values: GetTopFiltersNoResultsValues[] | null;
 };

package/model/getTopFiltersNoResultsValue.ts

@@ -1,15 +1,14 @@
 // 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 { Operator } from './operator';
+
 export type GetTopFiltersNoResultsValue = {
   /**
    * Attribute name.
    */
   attribute: string;
 
-  /**
-   * Operator.
-   */
-  operator: string;
+  operator: Operator;
 
   /**
    * Attribute value.

package/model/getTopHitsResponse.ts

@@ -2,5 +2,9 @@
 
 import type { TopHitsResponse } from './topHitsResponse';
 import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';
+import type { TopHitsResponseWithRevenueAnalytics } from './topHitsResponseWithRevenueAnalytics';
 
-export type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics;
+export type GetTopHitsResponse =
+  | TopHitsResponse
+  | TopHitsResponseWithAnalytics
+  | TopHitsResponseWithRevenueAnalytics;

package/model/getTopSearchesResponse.ts

@@ -2,7 +2,9 @@
 
 import type { TopSearchesResponse } from './topSearchesResponse';
 import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';
+import type { TopSearchesResponseWithRevenueAnalytics } from './topSearchesResponseWithRevenueAnalytics';
 
 export type GetTopSearchesResponse =
   | TopSearchesResponse
-  | TopSearchesResponseWithAnalytics;
+  | TopSearchesResponseWithAnalytics
+  | TopSearchesResponseWithRevenueAnalytics;

package/model/getUsersCountResponse.ts

@@ -1,15 +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 { UserWithDate } from './userWithDate';
+import type { DailyUsers } from './dailyUsers';
 
 export type GetUsersCountResponse = {
   /**
-   * Number of occurrences.
+   * Number of unique users.
    */
   count: number;
 
   /**
-   * User count.
+   * Daily number of unique users.
    */
-  dates: UserWithDate[];
+  dates: DailyUsers[];
 };