sfcc-cip-analytics-client
Version:
SFCC Commerce Intelligence Platform Analytics Client
36 lines (35 loc) • 1.33 kB
TypeScript
import { SiteSpecificQueryTemplateParams, EnhancedQueryFunction } from "../helpers";
export interface VisitReferrerRecord {
visit_date: Date | string;
site_id: number;
device_class_code: string;
referrer_medium: string;
referrer_source: string;
referrer_term: string | null;
referrer_content: string | null;
referrer_name: string | null;
num_visits: number;
locale_id: number;
channel_id: number;
}
export interface TopReferrerAnalytics {
traffic_medium: string;
traffic_source: string;
total_visits: number;
visit_percentage: number;
}
interface TopReferrersQueryParams extends SiteSpecificQueryTemplateParams {
limit?: number;
}
/**
* Query top referrers to identify high-value traffic sources
* Business Question: Where is my traffic coming from and which sources drive the most valuable visitors?
* Primary users: Marketing teams
* @param client The Avatica client instance (must have an open connection)
* @param siteId The natural site ID to filter by
* @param dateRange Date range to filter results
* @param limit Number of top referrers to return (default: 20)
* @param batchSize Size of each batch to yield (default: 100)
*/
export declare const queryTopReferrers: EnhancedQueryFunction<TopReferrerAnalytics, TopReferrersQueryParams>;
export {};