sfcc-cip-analytics-client
Version:
SFCC Commerce Intelligence Platform Analytics Client
20 lines (19 loc) • 881 B
TypeScript
import { SiteSpecificQueryTemplateParams, EnhancedQueryFunction } from '../helpers';
export interface OcapiPerformanceRecord {
request_date: Date | string;
api_name: string;
api_resource: string;
total_requests: number;
total_response_time: number;
avg_response_time: number;
client_id: string;
}
/**
* Query OCAPI performance metrics to monitor system health and customer experience
* Business Question: Is our system performing well enough to support customer experience?
* Primary users: Operations teams, Engineering
* @param client The Avatica client instance (must have an open connection)
* @param params Query parameters including siteId and dateRange
* @param batchSize Size of each batch to yield (default: 100)
*/
export declare const queryOcapiRequests: EnhancedQueryFunction<OcapiPerformanceRecord, SiteSpecificQueryTemplateParams>;