@findlane/server 0.25.0 → 0.26.0

package/dist/index.cjs

@@ -357,6 +357,7 @@ class SearchServerClient {
         productCounts: (options = {}) => report("product-counts", options),
         product: (objectID, options = {}) => report(`products/${encodeURIComponent(objectID)}`, options),
         revenue: (options = {}) => report("revenue", options),
+        filterSales: (options = {}) => report("filter-sales", options),
         banners: (options = {}) => request(`/banners?range=${options.range ?? "30d"}`, "GET", undefined, options.signal)
       },
       upsert: (records, signal) => request("/records", "POST", { records }, signal),

package/dist/index.d.cts

@@ -750,6 +750,13 @@ export type ServerEvent = {
     list?: "goesWith" | "similar" | "together" | "related";
     from?: string;
     timestamp?: number;
+    /** When the search wasn't made on the store but opened from outside it: an ad, an email, or another site's
+     * link. Revenue from search leaves these clicks out. */
+    landing?: "ad" | "email" | "link";
+    /** With `landing: "ad"`: the ad's network, from its click ID or tags. */
+    network?: "google" | "microsoft" | "meta" | "tiktok" | "x" | "linkedin" | "pinterest" | "snapchat";
+    /** The filters of the search the click came from, as the search took them, for sales by filter value. */
+    filters?: Record<string, unknown>;
 } | {
     type: "addToCart";
     items: EventItem[];
@@ -1115,6 +1122,8 @@ export type RevenueQuery = {
     carts: number;
     orders: number;
     revenue: number;
+    /** Orders' value after this search when an ad, an email or another site opened it, not counted in `revenue`. */
+    openedRevenue: number;
     typed: string[];
 };
 /** A product's orders and their value, beside those found through search, and the query it was found by most. */
@@ -1126,6 +1135,7 @@ export type RevenueProduct = {
     revenue: number;
     searchOrders: number;
     searchRevenue: number;
+    openedRevenue: number;
     topQuery: string | null;
 };
 /** Revenue from search (0.20.0): purchases and add-to-carts of products the shopper clicked in search results in
@@ -1144,6 +1154,19 @@ export type RevenueReport = AnalyticsReport & {
     searchCarts: number;
     searchCartValue: number;
     searchClicks: number;
+    /** Orders and add-to-carts after searches an ad, an email or another site's link opened (0.26.0): the shopper didn't
+     * search, so they're left out of the search numbers. By kind, with the clicks on such searches. */
+    opened: {
+        orders: number;
+        revenue: number;
+        carts: number;
+        cartValue: number;
+        clicks: number;
+        byKind: Record<"ad" | "email" | "link", {
+            orders: number;
+            revenue: number;
+        }>;
+    };
     otherCurrencies: {
         currency: string;
         orders: number;
@@ -1164,6 +1187,31 @@ export type RevenueReport = AnalyticsReport & {
     /** The products bought after a search, the most revenue from search first, up to 50. */
     products: RevenueProduct[];
 };
+/** A filter value's clicks on results while it was chosen, and the add-to-carts, orders and revenue of the products
+ * clicked. */
+export type FilterValueSales = {
+    value: string;
+    clicks: number;
+    carts: number;
+    orders: number;
+    revenue: number;
+};
+/** Sales by filter value (0.26.0): for each facet field, the values shoppers filtered on, on searches and on category
+ * pages apart, attributed as revenue from search is. A click with several values counts for each. From when clicks
+ * started carrying filters (`since`). */
+export type FilterSalesReport = AnalyticsReport & {
+    computedAt: string;
+    since: string;
+    currency: string | null;
+    fields: {
+        field: string;
+        search: FilterValueSales[];
+        page: FilterValueSales[];
+    }[];
+    /** Searches without filters, to compare with. */
+    unfiltered: Omit<FilterValueSales, "value">;
+    visitorIds: boolean;
+};
 export declare class FindlaneError extends Error {
     status: number;
     constructor(status: number, message: string);
@@ -1351,6 +1399,8 @@ export declare class SearchServerClient {
             /** Revenue from search: orders and add-to-carts of products found through search, per query and per
              * product (0.20.0). */
             revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+            /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+            filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
             /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
              * over the last 7, 30 (by default) or 90 days (0.23.0). */
             banners: (options?: {
@@ -1557,6 +1607,8 @@ export declare class SearchServerClient {
                 /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                  * product (0.20.0). */
                 revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                 /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                  * over the last 7, 30 (by default) or 90 days (0.23.0). */
                 banners: (options?: {
@@ -1761,6 +1813,8 @@ export declare class SearchServerClient {
                     /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                      * product (0.20.0). */
                     revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                    /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                    filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                     /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                      * over the last 7, 30 (by default) or 90 days (0.23.0). */
                     banners: (options?: {
@@ -1965,6 +2019,8 @@ export declare class SearchServerClient {
                         /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                          * product (0.20.0). */
                         revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                        /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                        filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                         /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                          * over the last 7, 30 (by default) or 90 days (0.23.0). */
                         banners: (options?: {
@@ -2169,6 +2225,8 @@ export declare class SearchServerClient {
                             /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                              * product (0.20.0). */
                             revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                            /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                            filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                             /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                              * over the last 7, 30 (by default) or 90 days (0.23.0). */
                             banners: (options?: {
@@ -2373,6 +2431,8 @@ export declare class SearchServerClient {
                                 /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                  * product (0.20.0). */
                                 revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                 /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                  * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                 banners: (options?: {
@@ -2577,6 +2637,8 @@ export declare class SearchServerClient {
                                     /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                      * product (0.20.0). */
                                     revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                    /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                    filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                     /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                      * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                     banners: (options?: {
@@ -2781,6 +2843,8 @@ export declare class SearchServerClient {
                                         /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                          * product (0.20.0). */
                                         revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                        /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                        filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                         /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                          * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                         banners: (options?: {
@@ -2985,6 +3049,8 @@ export declare class SearchServerClient {
                                             /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                              * product (0.20.0). */
                                             revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                            /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                            filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                             /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                              * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                             banners: (options?: {
@@ -3189,6 +3255,8 @@ export declare class SearchServerClient {
                                                 /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                                  * product (0.20.0). */
                                                 revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                                /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                                filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                                 /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                                  * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                                 banners: (options?: {
@@ -3393,6 +3461,8 @@ export declare class SearchServerClient {
                                                     /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                                      * product (0.20.0). */
                                                     revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                                    /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                                    filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                                     /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                                      * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                                     banners: (options?: {

package/dist/index.d.ts

@@ -750,6 +750,13 @@ export type ServerEvent = {
     list?: "goesWith" | "similar" | "together" | "related";
     from?: string;
     timestamp?: number;
+    /** When the search wasn't made on the store but opened from outside it: an ad, an email, or another site's
+     * link. Revenue from search leaves these clicks out. */
+    landing?: "ad" | "email" | "link";
+    /** With `landing: "ad"`: the ad's network, from its click ID or tags. */
+    network?: "google" | "microsoft" | "meta" | "tiktok" | "x" | "linkedin" | "pinterest" | "snapchat";
+    /** The filters of the search the click came from, as the search took them, for sales by filter value. */
+    filters?: Record<string, unknown>;
 } | {
     type: "addToCart";
     items: EventItem[];
@@ -1115,6 +1122,8 @@ export type RevenueQuery = {
     carts: number;
     orders: number;
     revenue: number;
+    /** Orders' value after this search when an ad, an email or another site opened it, not counted in `revenue`. */
+    openedRevenue: number;
     typed: string[];
 };
 /** A product's orders and their value, beside those found through search, and the query it was found by most. */
@@ -1126,6 +1135,7 @@ export type RevenueProduct = {
     revenue: number;
     searchOrders: number;
     searchRevenue: number;
+    openedRevenue: number;
     topQuery: string | null;
 };
 /** Revenue from search (0.20.0): purchases and add-to-carts of products the shopper clicked in search results in
@@ -1144,6 +1154,19 @@ export type RevenueReport = AnalyticsReport & {
     searchCarts: number;
     searchCartValue: number;
     searchClicks: number;
+    /** Orders and add-to-carts after searches an ad, an email or another site's link opened (0.26.0): the shopper didn't
+     * search, so they're left out of the search numbers. By kind, with the clicks on such searches. */
+    opened: {
+        orders: number;
+        revenue: number;
+        carts: number;
+        cartValue: number;
+        clicks: number;
+        byKind: Record<"ad" | "email" | "link", {
+            orders: number;
+            revenue: number;
+        }>;
+    };
     otherCurrencies: {
         currency: string;
         orders: number;
@@ -1164,6 +1187,31 @@ export type RevenueReport = AnalyticsReport & {
     /** The products bought after a search, the most revenue from search first, up to 50. */
     products: RevenueProduct[];
 };
+/** A filter value's clicks on results while it was chosen, and the add-to-carts, orders and revenue of the products
+ * clicked. */
+export type FilterValueSales = {
+    value: string;
+    clicks: number;
+    carts: number;
+    orders: number;
+    revenue: number;
+};
+/** Sales by filter value (0.26.0): for each facet field, the values shoppers filtered on, on searches and on category
+ * pages apart, attributed as revenue from search is. A click with several values counts for each. From when clicks
+ * started carrying filters (`since`). */
+export type FilterSalesReport = AnalyticsReport & {
+    computedAt: string;
+    since: string;
+    currency: string | null;
+    fields: {
+        field: string;
+        search: FilterValueSales[];
+        page: FilterValueSales[];
+    }[];
+    /** Searches without filters, to compare with. */
+    unfiltered: Omit<FilterValueSales, "value">;
+    visitorIds: boolean;
+};
 export declare class FindlaneError extends Error {
     status: number;
     constructor(status: number, message: string);
@@ -1351,6 +1399,8 @@ export declare class SearchServerClient {
             /** Revenue from search: orders and add-to-carts of products found through search, per query and per
              * product (0.20.0). */
             revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+            /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+            filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
             /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
              * over the last 7, 30 (by default) or 90 days (0.23.0). */
             banners: (options?: {
@@ -1557,6 +1607,8 @@ export declare class SearchServerClient {
                 /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                  * product (0.20.0). */
                 revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                 /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                  * over the last 7, 30 (by default) or 90 days (0.23.0). */
                 banners: (options?: {
@@ -1761,6 +1813,8 @@ export declare class SearchServerClient {
                     /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                      * product (0.20.0). */
                     revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                    /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                    filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                     /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                      * over the last 7, 30 (by default) or 90 days (0.23.0). */
                     banners: (options?: {
@@ -1965,6 +2019,8 @@ export declare class SearchServerClient {
                         /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                          * product (0.20.0). */
                         revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                        /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                        filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                         /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                          * over the last 7, 30 (by default) or 90 days (0.23.0). */
                         banners: (options?: {
@@ -2169,6 +2225,8 @@ export declare class SearchServerClient {
                             /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                              * product (0.20.0). */
                             revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                            /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                            filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                             /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                              * over the last 7, 30 (by default) or 90 days (0.23.0). */
                             banners: (options?: {
@@ -2373,6 +2431,8 @@ export declare class SearchServerClient {
                                 /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                  * product (0.20.0). */
                                 revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                 /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                  * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                 banners: (options?: {
@@ -2577,6 +2637,8 @@ export declare class SearchServerClient {
                                     /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                      * product (0.20.0). */
                                     revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                    /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                    filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                     /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                      * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                     banners: (options?: {
@@ -2781,6 +2843,8 @@ export declare class SearchServerClient {
                                         /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                          * product (0.20.0). */
                                         revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                        /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                        filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                         /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                          * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                         banners: (options?: {
@@ -2985,6 +3049,8 @@ export declare class SearchServerClient {
                                             /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                              * product (0.20.0). */
                                             revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                            /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                            filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                             /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                              * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                             banners: (options?: {
@@ -3189,6 +3255,8 @@ export declare class SearchServerClient {
                                                 /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                                  * product (0.20.0). */
                                                 revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                                /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                                filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                                 /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                                  * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                                 banners: (options?: {
@@ -3393,6 +3461,8 @@ export declare class SearchServerClient {
                                                     /** Revenue from search: orders and add-to-carts of products found through search, per query and per
                                                      * product (0.20.0). */
                                                     revenue: (options?: Omit<AnalyticsOptions, "source">) => Promise<RevenueReport>;
+                                                    /** Sales by filter value: each facet value's clicks, add-to-carts, orders and revenue (0.26.0). */
+                                                    filterSales: (options?: Omit<AnalyticsOptions, "source">) => Promise<FilterSalesReport>;
                                                     /** Each banner's shown (shoppers' searches that showed it, cache answers included) and clicks, by its rule,
                                                      * over the last 7, 30 (by default) or 90 days (0.23.0). */
                                                     banners: (options?: {

package/dist/index.js

@@ -311,6 +311,7 @@ class SearchServerClient {
         productCounts: (options = {}) => report("product-counts", options),
         product: (objectID, options = {}) => report(`products/${encodeURIComponent(objectID)}`, options),
         revenue: (options = {}) => report("revenue", options),
+        filterSales: (options = {}) => report("filter-sales", options),
         banners: (options = {}) => request(`/banners?range=${options.range ?? "30d"}`, "GET", undefined, options.signal)
       },
       upsert: (records, signal) => request("/records", "POST", { records }, signal),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findlane/server",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "Findlane server SDK: upload catalogs, manage index settings, and search with a secret workspace API key.",
   "keywords": ["findlane", "search", "full-text search", "typo tolerance", "ecommerce search", "search api", "sdk"],
   "license": "MIT",