@aifeatures/admin-react 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +4 -4
- package/dist/index.d.cts +84 -3
- package/dist/index.d.ts +84 -3
- package/dist/index.js +4 -4
- package/package.json +14 -13
package/dist/index.d.cts
CHANGED
|
@@ -122,11 +122,18 @@ interface ApiError {
|
|
|
122
122
|
* its one second-dimension slot on a disambiguator; or because that kind of
|
|
123
123
|
* report has no row set to split at all.
|
|
124
124
|
*
|
|
125
|
-
*
|
|
125
|
+
* `goals_exceed_report_budget` is the conversions report's own: this site's
|
|
126
|
+
* goal definitions are too large to send to the pipe in one request, and the
|
|
127
|
+
* message names the number of batches and says what to shorten. It is the
|
|
128
|
+
* only one of these that is a property of the SITE rather than of the
|
|
129
|
+
* request, which makes showing an outage and a Retry actively misleading —
|
|
130
|
+
* the retry repeats the same 400 forever, and the thing to change is a goal.
|
|
131
|
+
*
|
|
132
|
+
* All four are EXPECTED consequences of the request, never outages, so a
|
|
126
133
|
* client that cannot tell them apart from an unreachable source shows the
|
|
127
134
|
* wrong recovery for every one of them.
|
|
128
135
|
*/
|
|
129
|
-
code?: 'filter_unsupported' | 'range_invalid' | 'dimension_unsupported';
|
|
136
|
+
code?: 'filter_unsupported' | 'range_invalid' | 'dimension_unsupported' | 'goals_exceed_report_budget';
|
|
130
137
|
}
|
|
131
138
|
/**
|
|
132
139
|
* A site's payment readiness (sites.paymentsStatus)
|
|
@@ -1418,6 +1425,64 @@ type AnalyticsTimeseries = AnalyticsSourced<AnalyticsTimeseriesRow[]> & {
|
|
|
1418
1425
|
*/
|
|
1419
1426
|
timezone?: string;
|
|
1420
1427
|
};
|
|
1428
|
+
/**
|
|
1429
|
+
* One goal's conversions for the window.
|
|
1430
|
+
*
|
|
1431
|
+
* `visitors` and `events` are different questions, not a precision choice: a
|
|
1432
|
+
* visitor who submits the same form three times is one visitor and three
|
|
1433
|
+
* events, and a merchant asking "how many leads" wants the second while one
|
|
1434
|
+
* asking "how many people" wants the first. Both are shown.
|
|
1435
|
+
*/
|
|
1436
|
+
interface AnalyticsConversionRow {
|
|
1437
|
+
/** Display name, resolved server-side so a name containing a comma survives transit. */
|
|
1438
|
+
goal: string;
|
|
1439
|
+
kind: 'pageview' | 'scroll' | 'event';
|
|
1440
|
+
/**
|
|
1441
|
+
* True for the goals every collecting site has without defining anything.
|
|
1442
|
+
* Worth surfacing: it is the difference between "we count this for you" and
|
|
1443
|
+
* "you asked us to count this".
|
|
1444
|
+
*/
|
|
1445
|
+
implicit: boolean;
|
|
1446
|
+
visitors: number;
|
|
1447
|
+
events: number;
|
|
1448
|
+
/**
|
|
1449
|
+
* Divided by SITE-WIDE unique visitors, not by anything on this row. Null —
|
|
1450
|
+
* never 0 — when the window had no visitors, because a rate of zero asserts
|
|
1451
|
+
* that visitors came and did not convert.
|
|
1452
|
+
*/
|
|
1453
|
+
conversion_rate: number | null;
|
|
1454
|
+
}
|
|
1455
|
+
/**
|
|
1456
|
+
* The conversions report, which carries more than `AnalyticsSourced` on its ok
|
|
1457
|
+
* branch, and every extra field is there to stop a specific wrong reading:
|
|
1458
|
+
*
|
|
1459
|
+
* denominator — what the rates are a ratio OF. Rows do not sum
|
|
1460
|
+
* to 100%, and without this the panel would be
|
|
1461
|
+
* showing percentages of an unnamed whole.
|
|
1462
|
+
* window_precedes_collection — a low number is partly the range's doing.
|
|
1463
|
+
* first_seen_unavailable — "could not ask", which is not the same claim as
|
|
1464
|
+
* "nothing was collected". Same doctrine as
|
|
1465
|
+
* `AnalyticsStatus`: never guess coverage from a
|
|
1466
|
+
* failed lookup.
|
|
1467
|
+
*
|
|
1468
|
+
* They travel with the payload rather than being read off /status for the reason
|
|
1469
|
+
* `AnalyticsTimeseries.timezone` documents — they are separate requests, and
|
|
1470
|
+
* pairing them lets a status failure quietly change what a number means.
|
|
1471
|
+
*/
|
|
1472
|
+
type AnalyticsConversions = {
|
|
1473
|
+
status: 'ok';
|
|
1474
|
+
data: AnalyticsConversionRow[];
|
|
1475
|
+
window: {
|
|
1476
|
+
from: string;
|
|
1477
|
+
to: string;
|
|
1478
|
+
};
|
|
1479
|
+
denominator: number;
|
|
1480
|
+
first_seen: string | null;
|
|
1481
|
+
first_seen_unavailable: boolean;
|
|
1482
|
+
window_precedes_collection: boolean;
|
|
1483
|
+
} | {
|
|
1484
|
+
status: 'unreachable';
|
|
1485
|
+
};
|
|
1421
1486
|
type AnalyticsChannels = AnalyticsSourced<AnalyticsChannelRow[]>;
|
|
1422
1487
|
type AnalyticsBreakdown = AnalyticsSourced<AnalyticsBreakdownRow[]>;
|
|
1423
1488
|
/** Realtime sits outside the historical window, so it carries an as-of instant. */
|
|
@@ -1595,6 +1660,16 @@ interface AifeaturesApiClient {
|
|
|
1595
1660
|
getAnalyticsRealtime(): Promise<AnalyticsRealtime>;
|
|
1596
1661
|
/** First-touch acquisition folded into channels. Visits, not visitors. */
|
|
1597
1662
|
getAnalyticsChannels(period: AnalyticsPeriod, filters?: AnalyticsFilter[]): Promise<AnalyticsChannels>;
|
|
1663
|
+
/**
|
|
1664
|
+
* Conversions per goal for the window.
|
|
1665
|
+
*
|
|
1666
|
+
* DELIBERATELY UNFILTERED, and unlike realtime this is the server's rule
|
|
1667
|
+
* rather than a choice here: the endpoint refuses `filters` with a named 400.
|
|
1668
|
+
* A goal is matched at query time across the whole window, and the rate's
|
|
1669
|
+
* denominator is site-wide visitors — a filtered denominator would make two
|
|
1670
|
+
* cards on one page divide by different wholes while both said "rate".
|
|
1671
|
+
*/
|
|
1672
|
+
getAnalyticsConversions(period: AnalyticsPeriod): Promise<AnalyticsConversions>;
|
|
1598
1673
|
/** One ranked breakdown, named by its path segment. */
|
|
1599
1674
|
getAnalyticsBreakdown(name: AnalyticsBreakdownName, period: AnalyticsPeriod, filters?: AnalyticsFilter[]): Promise<AnalyticsBreakdown>;
|
|
1600
1675
|
getEventDestinations(): Promise<EventDestination[]>;
|
|
@@ -2566,6 +2641,12 @@ interface UseAnalyticsReturn {
|
|
|
2566
2641
|
summary: ReportSlot<AnalyticsSummary>;
|
|
2567
2642
|
timeseries: ReportSlot<AnalyticsTimeseries>;
|
|
2568
2643
|
channels: ReportSlot<AnalyticsChannels>;
|
|
2644
|
+
/**
|
|
2645
|
+
* Conversions is SITE-WIDE even when the panel is filtered, because the
|
|
2646
|
+
* endpoint refuses filters. Whatever renders it has to say so — everything
|
|
2647
|
+
* else in this return narrows with the pills and this one does not.
|
|
2648
|
+
*/
|
|
2649
|
+
conversions: ReportSlot<AnalyticsConversions>;
|
|
2569
2650
|
breakdowns: Record<string, ReportSlot<AnalyticsBreakdown>>;
|
|
2570
2651
|
/** True until every report has settled, for the initial skeleton only. */
|
|
2571
2652
|
isLoading: boolean;
|
|
@@ -2765,4 +2846,4 @@ interface AnalyticsViewProps {
|
|
|
2765
2846
|
*/
|
|
2766
2847
|
declare function AnalyticsView({ filters: filtersProp, onFiltersChange, refreshKey, onBackToWebsite, className, published, lastPublishedAt, }: AnalyticsViewProps): react_jsx_runtime.JSX.Element;
|
|
2767
2848
|
|
|
2768
|
-
export { type AdjustInventoryInput, type AifeaturesApiClient, AifeaturesApiError, type AifeaturesContextValue, AifeaturesProvider, type AifeaturesProviderProps, type AnalyticsBreakdown, type AnalyticsBreakdownName, type AnalyticsBreakdownRow, type AnalyticsChannelRow, type AnalyticsChannels, type AnalyticsFilter, type AnalyticsFilterDimension, type AnalyticsPeriod, type AnalyticsRealtime, type AnalyticsSourced, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsSummaryData, type AnalyticsSummaryMetrics, type AnalyticsTimeseries, type AnalyticsTimeseriesRow, AnalyticsView, type AnalyticsViewProps, type ApiError, type Attachment, type BusinessSummary, type BusinessVisitors, type CreateEventDestinationInput, type CreateFormInput, type CreateOptionInput, type CreateProductInput, type CreatePromoInput, type CreateVariantInput, type Customer, type CustomerAddress, CustomerDetail, type CustomerDetail$1 as CustomerDetailData, type CustomerDetailProps, CustomersList, type CustomersListProps, type CustomersListResponse, type EmailDelivery, type EmailSideStatus, type EventDeliveriesListResponse, type EventDelivery, type EventDestination, type EventDestinationSecretResponse, type EventDestinationsListResponse, type Form, FormSettings, type FormSettingsProps, FormSubmissions, type FormSubmissionsProps, FormsDashboard, type FormsDashboardProps, FormsList, type FormsListProps, type FormsListResponse, type GetBusinessSummaryOptions, type GetCustomersOptions, type GetInvoicesOptions, type GetOrdersOptions, type GetPeopleOptions, type GetProductsOptions, type GetSubmissionsOptions, type GetSubscriptionsOptions, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceDeliveryState, InvoiceDetail, type InvoiceDetailProps, type InvoiceLabel, InvoiceLabelBadge, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, InvoicesList, type InvoicesListProps, InvoicesView, type InvoicesViewProps, LeadsView, type LeadsViewProps, type LowStockProduct, MAX_ANALYTICS_FILTERS, MAX_ANALYTICS_FILTER_VALUES, type NeedsAttentionItem, type NeedsAttentionType, type Order, OrderDetail, type OrderDetailProps, type OrderStatus, OrderStatusBadge, OrdersList, type OrdersListProps, OrdersView, type OrdersViewProps, type PaginatedInvoices, type PaginatedOrders, type PaginatedSubmissions, type PaginatedSubscriptions, PaymentsDashboard, type PaymentsDashboardProps, PaymentsSetup, type PaymentsSetupProps, type PaymentsStatus, type PaymentsStatusReason, type PaymentsStatusResponse, type PeopleListResponse, type Person, type PersonDetail, type PersonOrder, type PersonSource, type PersonSubmission, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentType, type ProductOption, ProductSettings, type ProductSettingsProps, type ProductStats, type ProductVariant, ProductsList, type ProductsListProps, type ProductsListResponse, ProductsView, type ProductsViewProps, type Promo, type PromosListResponse, PromosPanel, REALTIME_FAILURES_BEFORE_ERROR, REALTIME_POLL_MS, type RefundRequest, type ReportSlot, RetainerStatusBadge, RetainersPanel, type RetainersPanelProps, type RevenueCurrencyTotal, type RevenuePeriod, type SetInventoryInput, type SetOrderFulfillmentInput, type SettledRevenue, type Submission, SubmissionDetail, type SubmissionDetailProps, type SubmissionMetadata, type Subscription, SubscriptionsView, type SubscriptionsViewProps, type UpdateEventDestinationInput, type UpdateFormInput, type UpdateOptionInput, type UpdateProductInput, type UpdateVariantInput, type UseAnalyticsOptions, type UseAnalyticsReturn, type UseBusinessSummaryOptions, type UseBusinessSummaryReturn, type UseCustomersOptions, type UseCustomersReturn, type UseEventDestinationsReturn, type UseFormsReturn, type UseInvoicesOptions, type UseInvoicesReturn, type UseOrdersOptions, type UseOrdersReturn, type UsePaymentsStatusReturn, type UsePeopleOptions, type UsePeopleReturn, type UsePersonOptions, type UsePersonReturn, type UseProductsOptions, type UseProductsReturn, type UseRealtimeVisitorsReturn, type UseSubmissionsOptions, type UseSubmissionsReturn, type UseSubscriptionsOptions, type UseSubscriptionsReturn, type VariantInventory, type VariantOptionValue, VariantsEditor, type VariantsEditorProps, ViewShell, type ViewShellProps, WebhookDeliveries, type WebhookDeliveriesProps, WebhookSettings, type WebhookSettingsProps, chargedTotal, createApiClient, formatPrice, isZeroDecimalCurrency, toMajorUnits, toMinorUnits, useAifeaturesContext as useAifeatures, useAifeaturesContext, useAnalytics, useBusinessSummary, useCustomers, useEventDestinations, useForms, useInvoices, useOrders, usePaymentsStatus, usePeople, usePerson, useProducts, useRealtimeVisitors, useRetainers, useSubmissions, useSubscriptions };
|
|
2849
|
+
export { type AdjustInventoryInput, type AifeaturesApiClient, AifeaturesApiError, type AifeaturesContextValue, AifeaturesProvider, type AifeaturesProviderProps, type AnalyticsBreakdown, type AnalyticsBreakdownName, type AnalyticsBreakdownRow, type AnalyticsChannelRow, type AnalyticsChannels, type AnalyticsConversionRow, type AnalyticsConversions, type AnalyticsFilter, type AnalyticsFilterDimension, type AnalyticsPeriod, type AnalyticsRealtime, type AnalyticsSourced, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsSummaryData, type AnalyticsSummaryMetrics, type AnalyticsTimeseries, type AnalyticsTimeseriesRow, AnalyticsView, type AnalyticsViewProps, type ApiError, type Attachment, type BusinessSummary, type BusinessVisitors, type CreateEventDestinationInput, type CreateFormInput, type CreateOptionInput, type CreateProductInput, type CreatePromoInput, type CreateVariantInput, type Customer, type CustomerAddress, CustomerDetail, type CustomerDetail$1 as CustomerDetailData, type CustomerDetailProps, CustomersList, type CustomersListProps, type CustomersListResponse, type EmailDelivery, type EmailSideStatus, type EventDeliveriesListResponse, type EventDelivery, type EventDestination, type EventDestinationSecretResponse, type EventDestinationsListResponse, type Form, FormSettings, type FormSettingsProps, FormSubmissions, type FormSubmissionsProps, FormsDashboard, type FormsDashboardProps, FormsList, type FormsListProps, type FormsListResponse, type GetBusinessSummaryOptions, type GetCustomersOptions, type GetInvoicesOptions, type GetOrdersOptions, type GetPeopleOptions, type GetProductsOptions, type GetSubmissionsOptions, type GetSubscriptionsOptions, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceDeliveryState, InvoiceDetail, type InvoiceDetailProps, type InvoiceLabel, InvoiceLabelBadge, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, InvoicesList, type InvoicesListProps, InvoicesView, type InvoicesViewProps, LeadsView, type LeadsViewProps, type LowStockProduct, MAX_ANALYTICS_FILTERS, MAX_ANALYTICS_FILTER_VALUES, type NeedsAttentionItem, type NeedsAttentionType, type Order, OrderDetail, type OrderDetailProps, type OrderStatus, OrderStatusBadge, OrdersList, type OrdersListProps, OrdersView, type OrdersViewProps, type PaginatedInvoices, type PaginatedOrders, type PaginatedSubmissions, type PaginatedSubscriptions, PaymentsDashboard, type PaymentsDashboardProps, PaymentsSetup, type PaymentsSetupProps, type PaymentsStatus, type PaymentsStatusReason, type PaymentsStatusResponse, type PeopleListResponse, type Person, type PersonDetail, type PersonOrder, type PersonSource, type PersonSubmission, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentType, type ProductOption, ProductSettings, type ProductSettingsProps, type ProductStats, type ProductVariant, ProductsList, type ProductsListProps, type ProductsListResponse, ProductsView, type ProductsViewProps, type Promo, type PromosListResponse, PromosPanel, REALTIME_FAILURES_BEFORE_ERROR, REALTIME_POLL_MS, type RefundRequest, type ReportSlot, RetainerStatusBadge, RetainersPanel, type RetainersPanelProps, type RevenueCurrencyTotal, type RevenuePeriod, type SetInventoryInput, type SetOrderFulfillmentInput, type SettledRevenue, type Submission, SubmissionDetail, type SubmissionDetailProps, type SubmissionMetadata, type Subscription, SubscriptionsView, type SubscriptionsViewProps, type UpdateEventDestinationInput, type UpdateFormInput, type UpdateOptionInput, type UpdateProductInput, type UpdateVariantInput, type UseAnalyticsOptions, type UseAnalyticsReturn, type UseBusinessSummaryOptions, type UseBusinessSummaryReturn, type UseCustomersOptions, type UseCustomersReturn, type UseEventDestinationsReturn, type UseFormsReturn, type UseInvoicesOptions, type UseInvoicesReturn, type UseOrdersOptions, type UseOrdersReturn, type UsePaymentsStatusReturn, type UsePeopleOptions, type UsePeopleReturn, type UsePersonOptions, type UsePersonReturn, type UseProductsOptions, type UseProductsReturn, type UseRealtimeVisitorsReturn, type UseSubmissionsOptions, type UseSubmissionsReturn, type UseSubscriptionsOptions, type UseSubscriptionsReturn, type VariantInventory, type VariantOptionValue, VariantsEditor, type VariantsEditorProps, ViewShell, type ViewShellProps, WebhookDeliveries, type WebhookDeliveriesProps, WebhookSettings, type WebhookSettingsProps, chargedTotal, createApiClient, formatPrice, isZeroDecimalCurrency, toMajorUnits, toMinorUnits, useAifeaturesContext as useAifeatures, useAifeaturesContext, useAnalytics, useBusinessSummary, useCustomers, useEventDestinations, useForms, useInvoices, useOrders, usePaymentsStatus, usePeople, usePerson, useProducts, useRealtimeVisitors, useRetainers, useSubmissions, useSubscriptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -122,11 +122,18 @@ interface ApiError {
|
|
|
122
122
|
* its one second-dimension slot on a disambiguator; or because that kind of
|
|
123
123
|
* report has no row set to split at all.
|
|
124
124
|
*
|
|
125
|
-
*
|
|
125
|
+
* `goals_exceed_report_budget` is the conversions report's own: this site's
|
|
126
|
+
* goal definitions are too large to send to the pipe in one request, and the
|
|
127
|
+
* message names the number of batches and says what to shorten. It is the
|
|
128
|
+
* only one of these that is a property of the SITE rather than of the
|
|
129
|
+
* request, which makes showing an outage and a Retry actively misleading —
|
|
130
|
+
* the retry repeats the same 400 forever, and the thing to change is a goal.
|
|
131
|
+
*
|
|
132
|
+
* All four are EXPECTED consequences of the request, never outages, so a
|
|
126
133
|
* client that cannot tell them apart from an unreachable source shows the
|
|
127
134
|
* wrong recovery for every one of them.
|
|
128
135
|
*/
|
|
129
|
-
code?: 'filter_unsupported' | 'range_invalid' | 'dimension_unsupported';
|
|
136
|
+
code?: 'filter_unsupported' | 'range_invalid' | 'dimension_unsupported' | 'goals_exceed_report_budget';
|
|
130
137
|
}
|
|
131
138
|
/**
|
|
132
139
|
* A site's payment readiness (sites.paymentsStatus)
|
|
@@ -1418,6 +1425,64 @@ type AnalyticsTimeseries = AnalyticsSourced<AnalyticsTimeseriesRow[]> & {
|
|
|
1418
1425
|
*/
|
|
1419
1426
|
timezone?: string;
|
|
1420
1427
|
};
|
|
1428
|
+
/**
|
|
1429
|
+
* One goal's conversions for the window.
|
|
1430
|
+
*
|
|
1431
|
+
* `visitors` and `events` are different questions, not a precision choice: a
|
|
1432
|
+
* visitor who submits the same form three times is one visitor and three
|
|
1433
|
+
* events, and a merchant asking "how many leads" wants the second while one
|
|
1434
|
+
* asking "how many people" wants the first. Both are shown.
|
|
1435
|
+
*/
|
|
1436
|
+
interface AnalyticsConversionRow {
|
|
1437
|
+
/** Display name, resolved server-side so a name containing a comma survives transit. */
|
|
1438
|
+
goal: string;
|
|
1439
|
+
kind: 'pageview' | 'scroll' | 'event';
|
|
1440
|
+
/**
|
|
1441
|
+
* True for the goals every collecting site has without defining anything.
|
|
1442
|
+
* Worth surfacing: it is the difference between "we count this for you" and
|
|
1443
|
+
* "you asked us to count this".
|
|
1444
|
+
*/
|
|
1445
|
+
implicit: boolean;
|
|
1446
|
+
visitors: number;
|
|
1447
|
+
events: number;
|
|
1448
|
+
/**
|
|
1449
|
+
* Divided by SITE-WIDE unique visitors, not by anything on this row. Null —
|
|
1450
|
+
* never 0 — when the window had no visitors, because a rate of zero asserts
|
|
1451
|
+
* that visitors came and did not convert.
|
|
1452
|
+
*/
|
|
1453
|
+
conversion_rate: number | null;
|
|
1454
|
+
}
|
|
1455
|
+
/**
|
|
1456
|
+
* The conversions report, which carries more than `AnalyticsSourced` on its ok
|
|
1457
|
+
* branch, and every extra field is there to stop a specific wrong reading:
|
|
1458
|
+
*
|
|
1459
|
+
* denominator — what the rates are a ratio OF. Rows do not sum
|
|
1460
|
+
* to 100%, and without this the panel would be
|
|
1461
|
+
* showing percentages of an unnamed whole.
|
|
1462
|
+
* window_precedes_collection — a low number is partly the range's doing.
|
|
1463
|
+
* first_seen_unavailable — "could not ask", which is not the same claim as
|
|
1464
|
+
* "nothing was collected". Same doctrine as
|
|
1465
|
+
* `AnalyticsStatus`: never guess coverage from a
|
|
1466
|
+
* failed lookup.
|
|
1467
|
+
*
|
|
1468
|
+
* They travel with the payload rather than being read off /status for the reason
|
|
1469
|
+
* `AnalyticsTimeseries.timezone` documents — they are separate requests, and
|
|
1470
|
+
* pairing them lets a status failure quietly change what a number means.
|
|
1471
|
+
*/
|
|
1472
|
+
type AnalyticsConversions = {
|
|
1473
|
+
status: 'ok';
|
|
1474
|
+
data: AnalyticsConversionRow[];
|
|
1475
|
+
window: {
|
|
1476
|
+
from: string;
|
|
1477
|
+
to: string;
|
|
1478
|
+
};
|
|
1479
|
+
denominator: number;
|
|
1480
|
+
first_seen: string | null;
|
|
1481
|
+
first_seen_unavailable: boolean;
|
|
1482
|
+
window_precedes_collection: boolean;
|
|
1483
|
+
} | {
|
|
1484
|
+
status: 'unreachable';
|
|
1485
|
+
};
|
|
1421
1486
|
type AnalyticsChannels = AnalyticsSourced<AnalyticsChannelRow[]>;
|
|
1422
1487
|
type AnalyticsBreakdown = AnalyticsSourced<AnalyticsBreakdownRow[]>;
|
|
1423
1488
|
/** Realtime sits outside the historical window, so it carries an as-of instant. */
|
|
@@ -1595,6 +1660,16 @@ interface AifeaturesApiClient {
|
|
|
1595
1660
|
getAnalyticsRealtime(): Promise<AnalyticsRealtime>;
|
|
1596
1661
|
/** First-touch acquisition folded into channels. Visits, not visitors. */
|
|
1597
1662
|
getAnalyticsChannels(period: AnalyticsPeriod, filters?: AnalyticsFilter[]): Promise<AnalyticsChannels>;
|
|
1663
|
+
/**
|
|
1664
|
+
* Conversions per goal for the window.
|
|
1665
|
+
*
|
|
1666
|
+
* DELIBERATELY UNFILTERED, and unlike realtime this is the server's rule
|
|
1667
|
+
* rather than a choice here: the endpoint refuses `filters` with a named 400.
|
|
1668
|
+
* A goal is matched at query time across the whole window, and the rate's
|
|
1669
|
+
* denominator is site-wide visitors — a filtered denominator would make two
|
|
1670
|
+
* cards on one page divide by different wholes while both said "rate".
|
|
1671
|
+
*/
|
|
1672
|
+
getAnalyticsConversions(period: AnalyticsPeriod): Promise<AnalyticsConversions>;
|
|
1598
1673
|
/** One ranked breakdown, named by its path segment. */
|
|
1599
1674
|
getAnalyticsBreakdown(name: AnalyticsBreakdownName, period: AnalyticsPeriod, filters?: AnalyticsFilter[]): Promise<AnalyticsBreakdown>;
|
|
1600
1675
|
getEventDestinations(): Promise<EventDestination[]>;
|
|
@@ -2566,6 +2641,12 @@ interface UseAnalyticsReturn {
|
|
|
2566
2641
|
summary: ReportSlot<AnalyticsSummary>;
|
|
2567
2642
|
timeseries: ReportSlot<AnalyticsTimeseries>;
|
|
2568
2643
|
channels: ReportSlot<AnalyticsChannels>;
|
|
2644
|
+
/**
|
|
2645
|
+
* Conversions is SITE-WIDE even when the panel is filtered, because the
|
|
2646
|
+
* endpoint refuses filters. Whatever renders it has to say so — everything
|
|
2647
|
+
* else in this return narrows with the pills and this one does not.
|
|
2648
|
+
*/
|
|
2649
|
+
conversions: ReportSlot<AnalyticsConversions>;
|
|
2569
2650
|
breakdowns: Record<string, ReportSlot<AnalyticsBreakdown>>;
|
|
2570
2651
|
/** True until every report has settled, for the initial skeleton only. */
|
|
2571
2652
|
isLoading: boolean;
|
|
@@ -2765,4 +2846,4 @@ interface AnalyticsViewProps {
|
|
|
2765
2846
|
*/
|
|
2766
2847
|
declare function AnalyticsView({ filters: filtersProp, onFiltersChange, refreshKey, onBackToWebsite, className, published, lastPublishedAt, }: AnalyticsViewProps): react_jsx_runtime.JSX.Element;
|
|
2767
2848
|
|
|
2768
|
-
export { type AdjustInventoryInput, type AifeaturesApiClient, AifeaturesApiError, type AifeaturesContextValue, AifeaturesProvider, type AifeaturesProviderProps, type AnalyticsBreakdown, type AnalyticsBreakdownName, type AnalyticsBreakdownRow, type AnalyticsChannelRow, type AnalyticsChannels, type AnalyticsFilter, type AnalyticsFilterDimension, type AnalyticsPeriod, type AnalyticsRealtime, type AnalyticsSourced, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsSummaryData, type AnalyticsSummaryMetrics, type AnalyticsTimeseries, type AnalyticsTimeseriesRow, AnalyticsView, type AnalyticsViewProps, type ApiError, type Attachment, type BusinessSummary, type BusinessVisitors, type CreateEventDestinationInput, type CreateFormInput, type CreateOptionInput, type CreateProductInput, type CreatePromoInput, type CreateVariantInput, type Customer, type CustomerAddress, CustomerDetail, type CustomerDetail$1 as CustomerDetailData, type CustomerDetailProps, CustomersList, type CustomersListProps, type CustomersListResponse, type EmailDelivery, type EmailSideStatus, type EventDeliveriesListResponse, type EventDelivery, type EventDestination, type EventDestinationSecretResponse, type EventDestinationsListResponse, type Form, FormSettings, type FormSettingsProps, FormSubmissions, type FormSubmissionsProps, FormsDashboard, type FormsDashboardProps, FormsList, type FormsListProps, type FormsListResponse, type GetBusinessSummaryOptions, type GetCustomersOptions, type GetInvoicesOptions, type GetOrdersOptions, type GetPeopleOptions, type GetProductsOptions, type GetSubmissionsOptions, type GetSubscriptionsOptions, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceDeliveryState, InvoiceDetail, type InvoiceDetailProps, type InvoiceLabel, InvoiceLabelBadge, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, InvoicesList, type InvoicesListProps, InvoicesView, type InvoicesViewProps, LeadsView, type LeadsViewProps, type LowStockProduct, MAX_ANALYTICS_FILTERS, MAX_ANALYTICS_FILTER_VALUES, type NeedsAttentionItem, type NeedsAttentionType, type Order, OrderDetail, type OrderDetailProps, type OrderStatus, OrderStatusBadge, OrdersList, type OrdersListProps, OrdersView, type OrdersViewProps, type PaginatedInvoices, type PaginatedOrders, type PaginatedSubmissions, type PaginatedSubscriptions, PaymentsDashboard, type PaymentsDashboardProps, PaymentsSetup, type PaymentsSetupProps, type PaymentsStatus, type PaymentsStatusReason, type PaymentsStatusResponse, type PeopleListResponse, type Person, type PersonDetail, type PersonOrder, type PersonSource, type PersonSubmission, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentType, type ProductOption, ProductSettings, type ProductSettingsProps, type ProductStats, type ProductVariant, ProductsList, type ProductsListProps, type ProductsListResponse, ProductsView, type ProductsViewProps, type Promo, type PromosListResponse, PromosPanel, REALTIME_FAILURES_BEFORE_ERROR, REALTIME_POLL_MS, type RefundRequest, type ReportSlot, RetainerStatusBadge, RetainersPanel, type RetainersPanelProps, type RevenueCurrencyTotal, type RevenuePeriod, type SetInventoryInput, type SetOrderFulfillmentInput, type SettledRevenue, type Submission, SubmissionDetail, type SubmissionDetailProps, type SubmissionMetadata, type Subscription, SubscriptionsView, type SubscriptionsViewProps, type UpdateEventDestinationInput, type UpdateFormInput, type UpdateOptionInput, type UpdateProductInput, type UpdateVariantInput, type UseAnalyticsOptions, type UseAnalyticsReturn, type UseBusinessSummaryOptions, type UseBusinessSummaryReturn, type UseCustomersOptions, type UseCustomersReturn, type UseEventDestinationsReturn, type UseFormsReturn, type UseInvoicesOptions, type UseInvoicesReturn, type UseOrdersOptions, type UseOrdersReturn, type UsePaymentsStatusReturn, type UsePeopleOptions, type UsePeopleReturn, type UsePersonOptions, type UsePersonReturn, type UseProductsOptions, type UseProductsReturn, type UseRealtimeVisitorsReturn, type UseSubmissionsOptions, type UseSubmissionsReturn, type UseSubscriptionsOptions, type UseSubscriptionsReturn, type VariantInventory, type VariantOptionValue, VariantsEditor, type VariantsEditorProps, ViewShell, type ViewShellProps, WebhookDeliveries, type WebhookDeliveriesProps, WebhookSettings, type WebhookSettingsProps, chargedTotal, createApiClient, formatPrice, isZeroDecimalCurrency, toMajorUnits, toMinorUnits, useAifeaturesContext as useAifeatures, useAifeaturesContext, useAnalytics, useBusinessSummary, useCustomers, useEventDestinations, useForms, useInvoices, useOrders, usePaymentsStatus, usePeople, usePerson, useProducts, useRealtimeVisitors, useRetainers, useSubmissions, useSubscriptions };
|
|
2849
|
+
export { type AdjustInventoryInput, type AifeaturesApiClient, AifeaturesApiError, type AifeaturesContextValue, AifeaturesProvider, type AifeaturesProviderProps, type AnalyticsBreakdown, type AnalyticsBreakdownName, type AnalyticsBreakdownRow, type AnalyticsChannelRow, type AnalyticsChannels, type AnalyticsConversionRow, type AnalyticsConversions, type AnalyticsFilter, type AnalyticsFilterDimension, type AnalyticsPeriod, type AnalyticsRealtime, type AnalyticsSourced, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsSummaryData, type AnalyticsSummaryMetrics, type AnalyticsTimeseries, type AnalyticsTimeseriesRow, AnalyticsView, type AnalyticsViewProps, type ApiError, type Attachment, type BusinessSummary, type BusinessVisitors, type CreateEventDestinationInput, type CreateFormInput, type CreateOptionInput, type CreateProductInput, type CreatePromoInput, type CreateVariantInput, type Customer, type CustomerAddress, CustomerDetail, type CustomerDetail$1 as CustomerDetailData, type CustomerDetailProps, CustomersList, type CustomersListProps, type CustomersListResponse, type EmailDelivery, type EmailSideStatus, type EventDeliveriesListResponse, type EventDelivery, type EventDestination, type EventDestinationSecretResponse, type EventDestinationsListResponse, type Form, FormSettings, type FormSettingsProps, FormSubmissions, type FormSubmissionsProps, FormsDashboard, type FormsDashboardProps, FormsList, type FormsListProps, type FormsListResponse, type GetBusinessSummaryOptions, type GetCustomersOptions, type GetInvoicesOptions, type GetOrdersOptions, type GetPeopleOptions, type GetProductsOptions, type GetSubmissionsOptions, type GetSubscriptionsOptions, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceDeliveryState, InvoiceDetail, type InvoiceDetailProps, type InvoiceLabel, InvoiceLabelBadge, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, InvoicesList, type InvoicesListProps, InvoicesView, type InvoicesViewProps, LeadsView, type LeadsViewProps, type LowStockProduct, MAX_ANALYTICS_FILTERS, MAX_ANALYTICS_FILTER_VALUES, type NeedsAttentionItem, type NeedsAttentionType, type Order, OrderDetail, type OrderDetailProps, type OrderStatus, OrderStatusBadge, OrdersList, type OrdersListProps, OrdersView, type OrdersViewProps, type PaginatedInvoices, type PaginatedOrders, type PaginatedSubmissions, type PaginatedSubscriptions, PaymentsDashboard, type PaymentsDashboardProps, PaymentsSetup, type PaymentsSetupProps, type PaymentsStatus, type PaymentsStatusReason, type PaymentsStatusResponse, type PeopleListResponse, type Person, type PersonDetail, type PersonOrder, type PersonSource, type PersonSubmission, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentType, type ProductOption, ProductSettings, type ProductSettingsProps, type ProductStats, type ProductVariant, ProductsList, type ProductsListProps, type ProductsListResponse, ProductsView, type ProductsViewProps, type Promo, type PromosListResponse, PromosPanel, REALTIME_FAILURES_BEFORE_ERROR, REALTIME_POLL_MS, type RefundRequest, type ReportSlot, RetainerStatusBadge, RetainersPanel, type RetainersPanelProps, type RevenueCurrencyTotal, type RevenuePeriod, type SetInventoryInput, type SetOrderFulfillmentInput, type SettledRevenue, type Submission, SubmissionDetail, type SubmissionDetailProps, type SubmissionMetadata, type Subscription, SubscriptionsView, type SubscriptionsViewProps, type UpdateEventDestinationInput, type UpdateFormInput, type UpdateOptionInput, type UpdateProductInput, type UpdateVariantInput, type UseAnalyticsOptions, type UseAnalyticsReturn, type UseBusinessSummaryOptions, type UseBusinessSummaryReturn, type UseCustomersOptions, type UseCustomersReturn, type UseEventDestinationsReturn, type UseFormsReturn, type UseInvoicesOptions, type UseInvoicesReturn, type UseOrdersOptions, type UseOrdersReturn, type UsePaymentsStatusReturn, type UsePeopleOptions, type UsePeopleReturn, type UsePersonOptions, type UsePersonReturn, type UseProductsOptions, type UseProductsReturn, type UseRealtimeVisitorsReturn, type UseSubmissionsOptions, type UseSubmissionsReturn, type UseSubscriptionsOptions, type UseSubscriptionsReturn, type VariantInventory, type VariantOptionValue, VariantsEditor, type VariantsEditorProps, ViewShell, type ViewShellProps, WebhookDeliveries, type WebhookDeliveriesProps, WebhookSettings, type WebhookSettingsProps, chargedTotal, createApiClient, formatPrice, isZeroDecimalCurrency, toMajorUnits, toMinorUnits, useAifeaturesContext as useAifeatures, useAifeaturesContext, useAnalytics, useBusinessSummary, useCustomers, useEventDestinations, useForms, useInvoices, useOrders, usePaymentsStatus, usePeople, usePerson, useProducts, useRealtimeVisitors, useRetainers, useSubmissions, useSubscriptions };
|