@vepler/area-reference-types/routes/metrics/common.d.ts

TypeScript type definitions for Vepler Area Reference API

/**
 * Common types shared across Metrics API endpoints
 */
/**
 * Metric data type
 */
export type MetricDataType = 'numeric' | 'categorical' | 'boolean' | 'text';
/**
 * Metric aggregation method
 */
export type MetricAggregation = 'sum' | 'average' | 'min' | 'max' | 'count' | 'median';
/**
 * Metrics error response
 */
export interface MetricsErrorResponse {
    /**
     * Success flag
     */
    success: false;
    /**
     * Error message
     */
    error: string;
    /**
     * HTTP status code
     */
    statusCode: number;
    /**
     * Additional error details
     */
    details?: {
        /**
         * Invalid metric IDs
         */
        invalidMetricIds?: string[];
        /**
         * Invalid entity codes
         */
        invalidEntityCodes?: string[];
        /**
         * Validation errors
         */
        validationErrors?: Array<{
            field: string;
            message: string;
        }>;
    };
}