import {z} from 'zod' export type GetApiApiV2ExperimentsExperimentIdResultsArgs = {experiment_id: string}; export type GetApiApiV2ExperimentsExperimentIdResultsOptions = {baseUrl?: string | undefined, apiKeyAuth?: string | undefined, appKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const experimentsConfidenceInterval = z.object({lower: z.number().optional(), upper: z.number().optional()}); export const experimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItemsLiftType = z.enum(["RELATIVE", "ABSOLUTE", "UNKNOWN"]); export const experimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItemsMethod = z.enum(["FIXED_SAMPLE", "BAYESIAN", "SEQUENTIAL", "SEQUENTIAL_FIXED_HYBRID", "UNKNOWN"]); export const experimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItemsUnreliableReason = z.enum(["CONTROL_DENOMINATOR_NEAR_ZERO", "TREATMENT_DENOMINATOR_NEAR_ZERO", "CONTROL_AND_TREATMENT_DENOMINATORS_NEAR_ZERO", "CONTROL_MEAN_NEAR_ZERO", "ZERO_VARIANCE", "UNKNOWN"]); export const experimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItems = z.object({confidence_interval: experimentsConfidenceInterval.optional(), confidence_level: z.number().optional(), evsi: z.number().optional(), expectation_above_zero: z.number().optional(), expectation_below_zero: z.number().optional(), global_lift: z.number().optional(), global_lift_lower_bound: z.number().optional(), global_lift_upper_bound: z.number().optional(), is_cuped_adjusted: z.boolean().optional(), is_unreliable: z.boolean().optional(), lift_type: experimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItemsLiftType.optional(), method: experimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItemsMethod.optional(), minimum_expected_regret: z.number().optional(), p_value: z.number().optional(), point_estimate: z.number().optional(), probability_above_zero: z.number().optional(), probability_below_zero: z.number().optional(), standard_error: z.number().optional(), unreliable_reason: experimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItemsUnreliableReason.optional(), variant_metric_value: z.number().nullable().optional(), z_score: z.number().optional()}); export const experimentsVariantResultsV2DTODataAttributesMetricsItemsCoverageSummary = z.object({control_total: z.number().optional(), coverage: z.number().optional(), coverage_unavailable_reason: z.string().optional(), eligible_population_total: z.number().optional(), experiment_total: z.number().optional(), global_metric_total: z.number().optional(), traffic_allocation: z.number().optional()}); export const experimentsMetricV2DTODataAttributesDesiredChange = z.enum(["METRIC_INCREASES", "METRIC_DECREASES", "UNKNOWN"]); export const experimentsVariantResultsV2DTODataAttributesMetricsItems = z.object({analyses: z.array(experimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItems).optional(), assignment_count: z.number().int().optional(), coverage: z.number().optional(), coverage_summary: experimentsVariantResultsV2DTODataAttributesMetricsItemsCoverageSummary.optional(), coverage_unavailable_reason: z.string().optional(), denominator: z.number().nullable().optional(), desired_change: experimentsMetricV2DTODataAttributesDesiredChange.optional(), metric_id: z.string().optional(), metric_name: z.string().optional(), numerator: z.number().nullable().optional(), sub_metric_property_name: z.string().optional(), sub_metric_property_value: z.string().optional()}); export const experimentsVariantResultsV2DTODataAttributes = z.object({assignment_count: z.number().int().optional(), experiment_id: z.string().optional(), is_control: z.boolean().optional(), metrics: z.array(experimentsVariantResultsV2DTODataAttributesMetricsItems).optional(), variant_key: z.string().optional(), variant_name: z.string().optional()}); export const experimentsVariantResultsV2DTODataType = z.literal("experiment-variant-results"); export const experimentsVariantResultsV2DTOData = z.object({attributes: experimentsVariantResultsV2DTODataAttributes.optional(), id: z.string(), type: experimentsVariantResultsV2DTODataType}); export const experimentsExperimentResultsV2MetaDTO = z.object({is_stale: z.boolean().optional(), results_last_updated: z.string().nullable().optional(), stale_reasons: z.array(z.string()).optional()}); export const experimentsVariantResultsV2DTOArray = z.object({data: z.array(experimentsVariantResultsV2DTOData), meta: experimentsExperimentResultsV2MetaDTO.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get experiment results * * GET /api/v2/experiments/{experiment_id}/results * * Also accepts auth: AuthZ */ export const getApiApiV2ExperimentsExperimentIdResults = async (args: GetApiApiV2ExperimentsExperimentIdResultsArgs, options?: GetApiApiV2ExperimentsExperimentIdResultsOptions) => { const {baseUrl = "https://api.datadoghq.com", fetch: fetchFn = fetch, apiKeyAuth, appKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (apiKeyAuth !== undefined) headers.set("DD-API-KEY", apiKeyAuth) if (appKeyAuth !== undefined) headers.set("DD-APPLICATION-KEY", appKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/experiments/${encodeURIComponent(String(args.experiment_id))}/results${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(experimentsVariantResultsV2DTOArray, await res.json()) };