@algolia/client-analytics 5.9.0 → 5.10.0

package/model/clientMethodProps.ts

@@ -1,605 +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 { Direction } from '../model/direction';
-
-import { OrderBy } from '../model/orderBy';
-
-/**
- * Properties for the `customDelete` method.
- */
-export type CustomDeleteProps = {
-  /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to apply to the current query.
-   */
-  parameters?: { [key: string]: any };
-};
-
-/**
- * Properties for the `customGet` method.
- */
-export type CustomGetProps = {
-  /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to apply to the current query.
-   */
-  parameters?: { [key: string]: any };
-};
-
-/**
- * Properties for the `customPost` method.
- */
-export type CustomPostProps = {
-  /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to apply to the current query.
-   */
-  parameters?: { [key: string]: any };
-  /**
-   * Parameters to send with the custom request.
-   */
-  body?: Record<string, unknown>;
-};
-
-/**
- * Properties for the `customPut` method.
- */
-export type CustomPutProps = {
-  /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to apply to the current query.
-   */
-  parameters?: { [key: string]: any };
-  /**
-   * Parameters to send with the custom request.
-   */
-  body?: Record<string, unknown>;
-};
-
-/**
- * Properties for the `getAddToCartRate` method.
- */
-export type GetAddToCartRateProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getAverageClickPosition` method.
- */
-export type GetAverageClickPositionProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getClickPositions` method.
- */
-export type GetClickPositionsProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getClickThroughRate` method.
- */
-export type GetClickThroughRateProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getConversionRate` method.
- */
-export type GetConversionRateProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getNoClickRate` method.
- */
-export type GetNoClickRateProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getNoResultsRate` method.
- */
-export type GetNoResultsRateProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getPurchaseRate` method.
- */
-export type GetPurchaseRateProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getRevenue` method.
- */
-export type GetRevenueProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getSearchesCount` method.
- */
-export type GetSearchesCountProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getSearchesNoClicks` method.
- */
-export type GetSearchesNoClicksProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
-   */
-  limit?: number;
-  /**
-   * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
-   */
-  offset?: number;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getSearchesNoResults` method.
- */
-export type GetSearchesNoResultsProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
-   */
-  limit?: number;
-  /**
-   * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
-   */
-  offset?: number;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getStatus` method.
- */
-export type GetStatusProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-};
-
-/**
- * Properties for the `getTopCountries` method.
- */
-export type GetTopCountriesProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
-   */
-  limit?: number;
-  /**
-   * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
-   */
-  offset?: number;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getTopFilterAttributes` method.
- */
-export type GetTopFilterAttributesProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Search query.
-   */
-  search?: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
-   */
-  limit?: number;
-  /**
-   * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
-   */
-  offset?: number;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getTopFilterForAttribute` method.
- */
-export type GetTopFilterForAttributeProps = {
-  /**
-   * Attribute name.
-   */
-  attribute: string;
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Search query.
-   */
-  search?: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
-   */
-  limit?: number;
-  /**
-   * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
-   */
-  offset?: number;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getTopFiltersNoResults` method.
- */
-export type GetTopFiltersNoResultsProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Search query.
-   */
-  search?: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
-   */
-  limit?: number;
-  /**
-   * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
-   */
-  offset?: number;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getTopHits` method.
- */
-export type GetTopHitsProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Search query.
-   */
-  search?: string;
-  /**
-   * Whether to include metrics related to click and conversion events in the response.
-   */
-  clickAnalytics?: boolean;
-  /**
-   * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
-   */
-  revenueAnalytics?: boolean;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
-   */
-  limit?: number;
-  /**
-   * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
-   */
-  offset?: number;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getTopSearches` method.
- */
-export type GetTopSearchesProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Whether to include metrics related to click and conversion events in the response.
-   */
-  clickAnalytics?: boolean;
-  /**
-   * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
-   */
-  revenueAnalytics?: boolean;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
-   */
-  orderBy?: OrderBy;
-  /**
-   * Sorting direction of the results: ascending or descending.
-   */
-  direction?: Direction;
-  /**
-   * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
-   */
-  limit?: number;
-  /**
-   * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
-   */
-  offset?: number;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};
-
-/**
- * Properties for the `getUsersCount` method.
- */
-export type GetUsersCountProps = {
-  /**
-   * Index name.
-   */
-  index: string;
-  /**
-   * Start date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  startDate?: string;
-  /**
-   * End date of the period to analyze, in `YYYY-MM-DD` format.
-   */
-  endDate?: string;
-  /**
-   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
-   */
-  tags?: string;
-};

package/model/currencyCode.ts

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

package/model/dailyAddToCartRates.ts

@@ -1,23 +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 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

@@ -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 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

@@ -1,23 +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 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

@@ -1,23 +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 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;
-};