@algolia/client-analytics 4.14.1 → 5.0.0-alpha.10

package/model/clientMethodProps.ts

@@ -0,0 +1,530 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Direction } from './direction';
+import type { OrderBy } from './orderBy';
+
+/**
+ * Properties for the `del` method.
+ */
+export type DelProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `get` method.
+ */
+export type GetProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `getAverageClickPosition` method.
+ */
+export type GetAverageClickPositionProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getClickPositions` method.
+ */
+export type GetClickPositionsProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getClickThroughRate` method.
+ */
+export type GetClickThroughRateProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getConversationRate` method.
+ */
+export type GetConversationRateProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getNoClickRate` method.
+ */
+export type GetNoClickRateProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getNoResultsRate` method.
+ */
+export type GetNoResultsRateProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getSearchesCount` method.
+ */
+export type GetSearchesCountProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getSearchesNoClicks` method.
+ */
+export type GetSearchesNoClicksProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getSearchesNoResults` method.
+ */
+export type GetSearchesNoResultsProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getStatus` method.
+ */
+export type GetStatusProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+};
+
+/**
+ * Properties for the `getTopCountries` method.
+ */
+export type GetTopCountriesProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getTopFilterAttributes` method.
+ */
+export type GetTopFilterAttributesProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The query term to search for. Must match the exact user input.
+   */
+  search?: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getTopFilterForAttribute` method.
+ */
+export type GetTopFilterForAttributeProps = {
+  /**
+   * The exact name of the attribute.
+   */
+  attribute: string;
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The query term to search for. Must match the exact user input.
+   */
+  search?: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getTopFiltersNoResults` method.
+ */
+export type GetTopFiltersNoResultsProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The query term to search for. Must match the exact user input.
+   */
+  search?: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getTopHits` method.
+ */
+export type GetTopHitsProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The query term to search for. Must match the exact user input.
+   */
+  search?: string;
+  /**
+   * Whether to include the click-through and conversion rates for a search.
+   */
+  clickAnalytics?: boolean;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getTopSearches` method.
+ */
+export type GetTopSearchesProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * Whether to include the click-through and conversion rates for a search.
+   */
+  clickAnalytics?: boolean;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Reorder the results.
+   */
+  orderBy?: OrderBy;
+  /**
+   * The sorting of the result.
+   */
+  direction?: Direction;
+  /**
+   * Number of records to return. Limit is the size of the page.
+   */
+  limit?: number;
+  /**
+   * Position of the starting record. Used for paging. 0 is the first record.
+   */
+  offset?: number;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getUsersCount` method.
+ */
+export type GetUsersCountProps = {
+  /**
+   * The index name to target.
+   */
+  index: string;
+  /**
+   * The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `post` method.
+ */
+export type PostProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `put` method.
+ */
+export type PutProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};

package/model/conversionRateEvent.ts

@@ -0,0 +1,23 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type ConversionRateEvent = {
+  /**
+   * The click-through rate.
+   */
+  rate: number;
+
+  /**
+   * The number of tracked search click.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * The number of converted clicks.
+   */
+  conversionCount: number;
+
+  /**
+   * Date of the event.
+   */
+  date: string;
+};

package/model/direction.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type Direction = 'asc' | 'desc';

package/model/errorBase.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+  message?: string;
+};

package/model/getAverageClickPositionResponse.ts

@@ -0,0 +1,20 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AverageClickEvent } from './averageClickEvent';
+
+export type GetAverageClickPositionResponse = {
+  /**
+   * The average of all the click count event.
+   */
+  average: number;
+
+  /**
+   * The number of click event.
+   */
+  clickCount: number;
+
+  /**
+   * A list of average click position with their date.
+   */
+  dates: AverageClickEvent[];
+};

package/model/getClickPositionsResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ClickPosition } from './clickPosition';
+
+export type GetClickPositionsResponse = {
+  /**
+   * A list of the click positions with their click count.
+   */
+  positions: ClickPosition[];
+};

package/model/getClickThroughRateResponse.ts

@@ -0,0 +1,25 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ClickThroughRateEvent } from './clickThroughRateEvent';
+
+export type GetClickThroughRateResponse = {
+  /**
+   * The click-through rate.
+   */
+  rate: number;
+
+  /**
+   * The number of click event.
+   */
+  clickCount: number;
+
+  /**
+   * The number of tracked search click.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * A list of click-through rate events with their date.
+   */
+  dates: ClickThroughRateEvent[];
+};

package/model/getConversationRateResponse.ts

@@ -0,0 +1,25 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ConversionRateEvent } from './conversionRateEvent';
+
+export type GetConversationRateResponse = {
+  /**
+   * The click-through rate.
+   */
+  rate: number;
+
+  /**
+   * The number of tracked search click.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * The number of converted clicks.
+   */
+  conversionCount: number;
+
+  /**
+   * A list of conversion events with their date.
+   */
+  dates: ConversionRateEvent[];
+};

package/model/getNoClickRateResponse.ts

@@ -0,0 +1,25 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { NoClickRateEvent } from './noClickRateEvent';
+
+export type GetNoClickRateResponse = {
+  /**
+   * The click-through rate.
+   */
+  rate: number;
+
+  /**
+   * The number of click event.
+   */
+  count: number;
+
+  /**
+   * The number of click event.
+   */
+  noClickCount: number;
+
+  /**
+   * A list of searches without clicks with their date, rate and counts.
+   */
+  dates: NoClickRateEvent[];
+};

package/model/getNoResultsRateResponse.ts

@@ -0,0 +1,25 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { NoResultsRateEvent } from './noResultsRateEvent';
+
+export type GetNoResultsRateResponse = {
+  /**
+   * The click-through rate.
+   */
+  rate: number;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * The number of occurrences.
+   */
+  noResultCount: number;
+
+  /**
+   * A list of searches without results with their date, rate and counts.
+   */
+  dates: NoResultsRateEvent[];
+};