@algolia/client-analytics 5.0.0-alpha.98 → 5.0.0-beta.1

package/model/clientMethodProps.ts

@@ -67,24 +67,46 @@ export type CustomPutProps = {
   body?: Record<string, any>;
 };
 
+/**
+ * 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 to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -94,19 +116,19 @@ export type GetAverageClickPositionProps = {
  */
 export type GetClickPositionsProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -116,41 +138,41 @@ export type GetClickPositionsProps = {
  */
 export type GetClickThroughRateProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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 `getConversationRate` method.
+ * Properties for the `getConversionRate` method.
  */
-export type GetConversationRateProps = {
+export type GetConversionRateProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -160,19 +182,19 @@ export type GetConversationRateProps = {
  */
 export type GetNoClickRateProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -182,19 +204,63 @@ export type GetNoClickRateProps = {
  */
 export type GetNoResultsRateProps = {
   /**
-   * Index name to target.
+   * 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 (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -204,19 +270,19 @@ export type GetNoResultsRateProps = {
  */
 export type GetSearchesCountProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -226,27 +292,27 @@ export type GetSearchesCountProps = {
  */
 export type GetSearchesNoClicksProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -256,27 +322,27 @@ export type GetSearchesNoClicksProps = {
  */
 export type GetSearchesNoResultsProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -286,7 +352,7 @@ export type GetSearchesNoResultsProps = {
  */
 export type GetStatusProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
 };
@@ -296,27 +362,27 @@ export type GetStatusProps = {
  */
 export type GetTopCountriesProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -326,31 +392,31 @@ export type GetTopCountriesProps = {
  */
 export type GetTopFilterAttributesProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * User query.
+   * Search query.
    */
   search?: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -364,31 +430,31 @@ export type GetTopFilterForAttributeProps = {
    */
   attribute: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * User query.
+   * Search query.
    */
   search?: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -398,31 +464,31 @@ export type GetTopFilterForAttributeProps = {
  */
 export type GetTopFiltersNoResultsProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * User query.
+   * Search query.
    */
   search?: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -432,35 +498,39 @@ export type GetTopFiltersNoResultsProps = {
  */
 export type GetTopHitsProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * User query.
+   * Search query.
    */
   search?: string;
   /**
-   * Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
+   * Whether to include metrics related to click and conversion events in the response.
    */
   clickAnalytics?: boolean;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * 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 (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -470,23 +540,27 @@ export type GetTopHitsProps = {
  */
 export type GetTopSearchesProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
+   * Whether to include metrics related to click and conversion events in the response.
    */
   clickAnalytics?: boolean;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * 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 (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Reorder the results.
+   * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
    */
   orderBy?: OrderBy;
   /**
@@ -494,15 +568,15 @@ export type GetTopSearchesProps = {
    */
   direction?: Direction;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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;
 };
@@ -512,19 +586,19 @@ export type GetTopSearchesProps = {
  */
 export type GetUsersCountProps = {
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date of the period to analyze, in `YYYY-MM-DD` format.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date of the period to analyze, in `YYYY-MM-DD` format.
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+   * 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/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;
+};